Getting Started¶
Presumably you're here because you want to help by updating the JTE documentation, so thank you!
Tools¶
These docs are written in Markdown1 and compiled using MkDocs with the Material for MkDocs theme.
Development activities take place within containers and are orchestrated using Just.
| Tool | Description |
|---|---|
| Just | a task runner similar to Make with a simpler syntax |
| Docker | runtime environments are encapsulated in container images |
| MkDocs | Documentation framework |
| Material for MkDocs | Documentation styling |
| Mike | Documentation versioning |
| Markdownlint | Markdown Linter |
| Vale | Prose Linter |
| Visual Studio Code | Recommended IDE for docs development |
Required Prerequisites
You can get by with only Just and Docker. Local installations of the other tools may prove useful for development but aren't required.
Learn More¶
| Topic | Description |
|---|---|
| Documentation Structure | Learn how JTE's docs are organized |
| Local Development | Learn how to make changes to the docs locally |
| Markdownlint | Learn more about the Markdown linter |
| Prose Linting with Vale | Learn more about the Prose linter |
| Add or Remove Pages | Learn how to update the page tree |
| Markdown Cheatsheet | Learn more about Markdown Syntax for this site |