MKDocs Tutorial

see: https://www.mkdocs.org/getting-started/

Steps done:

1. nix-shell -p "(python3.withPackages (python-pkgs: [python-pkgs.mkdocs]))" or

   let
   pkgs = import <nixpkgs> {};
   in with pkgs; mkShell {
   packages = [
       (python312Full.withPackages (python-pkgs: with python-pkgs; [
       mkdocs
       pip
       ]))
   ];
   }

2. mkdocs new <project_name>

3. cd <project_name>

4. git init

5. mkdocs serve / mkdocs build

6. Added about.md file: https://www.mkdocs.org/getting-started/#adding-pages

7. Changed theme to readthedocs: https://www.mkdocs.org/user-guide/choosing-your-theme/

Next steps

• Markdown flavor and extensions:
  • https://www.mkdocs.org/user-guide/configuration/#markdown_extensions
  • https://python-markdown.github.io/extensions/