Skip to content

Contributions

Hi! We are happy that you thought of contributing! If you have any suggestions or issues, please raise it here. I would be happy if you could provide pull requests, if you know how to do it here.

Structure

Folder Structure

The structure of this repo is as follows:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
├── docs                    // Folders for documentation
│   ├── CNAME
│   ├── contributions.md
│   ├── deployment_and_automated_site_deployment.md
│   ├── flavoured_markdown.md
│   ├── images              // Assets
│   │   └── ...
│   │
│   ├── index.md
│   └── writing_markdown.md
├── LICENSE
├── mkdocs.yml              // MkDocs Configuration
├── overrides
│   └── partials
│       └── footer.html
├── README.md
└── requirements.txt

Development

Ye olde way

1
2
3
4
python -m venv .venv
./.venv/Scripts/activate
pip install -r requirements.txt
mkdocs serve

Docker

1
docker compose up

✨Devcontainer ✨

Install the devcontainer extension in VSCode and reopen the project a devcontainer.

Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server. Very helpful when you want to take a look at the docs before deploying.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.
  • mkdocs gh-deploy - Deploy in github pages
  • pip freeze > requirements.txt - Generate a requirements.txt file

Web Documentation Configuration

For full documentation visit: