Useful documentation

After a lot of thinking, following the example of @niqdev, I've decided to create this project to collect all the useful information about what I like most: programming.

Install mkdocs locally

python3 -m pip install -r requirements.txt
python3.11 -m pip install mkdocs-material

How to serve, build and deploy

To start the dev server:

$ mkdocs serve
INFO    -  Building documentation...
INFO    -  Cleaning site directory
[I 160402 15:50:43 server:271] Serving on http://127.0.0.1:8000
[I 160402 15:50:43 handlers:58] Start watching changes
[I 160402 15:50:43 handlers:60] Start detecting changes

In order to build the website:

mkdocs build

This will create a new directory, named site.

To deploy the website to GH pages:

mkdocs gh-deploy

Customization

Material Theme