🛠️ Adding to this Site
This site is built using Jekyll and hosted on GitHub Pages. The site is built using the Just the Docs theme.
📝 Writing Content
The content of this site is written in Markdown. You can write content in any text editor, but we recommend using a Markdown editor like Typora or Visual Studio Code.
🧰 Adding Pages
To add a new page to the site, create a new Markdown file in the docs
directory. The file should have a .md
extension and include a front matter block at the top of the file. The front matter block should include the following fields:
title
: The title of the pagelayout
: The layout to use for the page (usehome
for regular pages andpage
for pages without a sidebar)parent
: The parent page of the page (useWiki
for pages in the wiki section)nav_order
: The order of the page in the navigation menu
Here’s an example front matter block for a page in the wiki section:
---
title: Developers
layout: home
parent: Wiki
nav_order: 4
---
📂 Organizing Content
The content of the site is organized into a hierarchy of pages. You can create a hierarchy of pages by creating subdirectories in the docs
directory and placing pages inside those subdirectories. The navigation menu on the left side of the site is automatically generated based on the hierarchy of pages. The order of pages in the navigation menu is determined by the nav_order
field in the front matter block of each page, and the subdirectories are created using the has_children
field in the front matter block of the parent page.
Here’s an example front matter block for a parent page with children:
---
title: Wiki
layout: home
nav_order: 4
has_children: true
---