The website is built using the following software and technologies:
- AnchorJS anchors headings, MIT license
- Bootstrap UI toolkit, code under MIT license, docs under Creative Commons
- Favicon Generator for favicons
- Font Awesome for icons, SIL OFL 1.1 license
- highlight.js for syntax highlighting, BSD 3-Clause license
- Markdown markup language
- MKDocs static website generator, BSD-2-Clause license
- SASS for stylesheets, MIT license
Install poetry and run:
$ poetry install $ poetry run mkdocs serve
Use the automatic setup via mkdocs.sh
The local website should be available at http://localhost:8000/
This can be done either manually by creating a new .md file
in the docs/en/news/posts directory, paying attention for a correct filename,
date and front-matter, or by running the following command:
$ ./new_post.sh "New post title" "<author_name>"