Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 1.39 KB

README.md

File metadata and controls

42 lines (33 loc) · 1.39 KB
Raw

HCI CTP Resources

A curated site of resources for the Computing Talent Programme.

Contributing

You need the following installed:

Clone the repository:

git clone https://github.com/EC3-Gang/resources.git

Install dependencies:

yarn

Run the development server:

yarn docs:dev

To add a new page, create a new markdown file in the docs folder. The file name will be the URL path. For example, docs/competitive-programming/index.md will be accessible at /competitive-programming/. You will need to add the following frontmatter to the top of the file:

---
title: My Page Title
---

You will also need to add the page to the sidebar in .vitepress/config.mts. To find which file the sidebar for a certain section is located in, check themeConfig.sidebar in .vitepress/config.mts. Trace the file path from there. For example, the sidebar for the Competitive Programming section is located in .vitepress/cp-sidebar.mts.

Add an object containing the link to the page and the title of the page to the items array in the sidebar file. For example, to add a link to docs/competitive-programming/index.md in the sidebar, add the following object to the array in .vitepress/cp-sidebar.mts:

{
	text: 'My Page Title',
	link: '/competitive-programming/'
}