Skip to content

About this website

Documentation is made in Markdown format.

The editor that I use for this is Visual Studio Code with the following plugins:

  • LTEX+
  • Dracula Theme Official
  • GitHub Pull Requests
  • Markdown All in One
  • markdownlint
  • Material Icon Theme
  • Prettier - Code formatter
  • YAML

To convert the markdown documentation to static webpages I use Material for MKDocs

I watched the following tutorial for this Material for MkDocs: Full Tutorial To Build And Deploy Your Docs Portal

The documentation is saved to GitHub

The website is hosted on cloudflare pages
Through Build > Compute > Workers & Pages, cloudflare pulls the files from my GitHub repo and runs mkdocs and mkdocs-material to build the website.

Build configuration:
Framework preset: None
Build command: pip install -r requirements.txt && mkdocs build
Build output directory: site

The requirements.txt file containts the following:
mkdocs-material