Docs Template

Running Docs Site Locally

This repository uses submodules. To ensure you have everything you need, clone recursively:

git clone --recursive https://github.com/CoderDojoBrighton/your-project.git

We use the static site generator Hugo. You can find the installation instructions here.

To run the docs:

hugo serve
# Or
make docs

This should live-reload as you edit content.

Editing Tips

The docs site uses the following layout:

your-project
├─ hugo.toml - Site settings
├─ content/
|  ├─ _index.md - Main page content
|  ├─ docs/
|  |  ├─ section-1/
|  |  |  ├─ _index.md - Secion 1 contents. Defines sidebar settings
|  |  |  ├─ topic-1
|  |  |  |  ├─ _index.md - Content for topic-1

Hugo uses Markdown.

Additionally, shortcodes can be used - essentially templates for content. For example, highlightable code blocks, YouTube video player and Gists. The theme we use provides additional shortcodes for things like mermaid diagrams, hints and expandable sections.

Photos should be added to static/project-name/.... They can then be added to a page like this:

![Description here](/your-project/project-name/...)