Skip to content

Getting started⚓︎

🛠 Installation⚓︎

Without asdf vm⚓︎

# This project uses python 3.10.4
python --version

# Install poetry
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/install-poetry.py

# Check if poetry is installed
poetry --version

The project contains .tool-versions file with the versions of tools that are used in the project.

# Install asdf version manager from https://asdf-vm.com/guide/getting-started.html#_3-install-asdf

# Install all asdf plugins defined in .tool-versions
cat .tool-versions | awk '{print $1}' | xargs -I _ asdf plugin add _ 

asdf install

# Check if poetry is installed
poetry --version

Development⚓︎

Install dependencies⚓︎

poetry install

Start virtual environment⚓︎

poetry shell

Run dev server⚓︎

poetry run mkdocs serve

⚙ Build⚓︎

poetry run mkdocs build

Optionally, you can specify additional arguments to the build command:

poetry run mkdocs build --verbose --clean --site-dir site

🧪 Testing⚓︎

Since this is a documentation project, it is not necessary to test it.

🚀 Deployment⚓︎

The project is deployed to GitHub Pages automatically by .github/workflows/deploy.yml github workflow. You can deploy it manually by running the following command:

poetry run mkdocs gh-deploy

📝 Contributing⚓︎

Project layout⚓︎

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

For more infomation, refer to mkdocs-material documentation.