Zentauri Knowledge Database

This is the static mkdocs documentation for myself

How to use the MKDocs Materials Documentation Platform

MKDocs Materials Requirements

• just

  cargo install just
  conda install -c conda-forge just
  brew install just
  npm install -g rust-just
  pipx install rust-just

• Python 3
  • Python
  • Anaconda
• Python Modules (can be installed with pipenv)

  just venv-create

Just file recipes

just --list
Available recipes:
    build        # Build HTML static site
    clean        # Delete build folder(s)
    conda-create # Create the build environment
    deploy       # Deploy on gh-pages
    env-export   # Export the build environment
    info         # Information about the environment
    serve        # Build HTML static site and serve it locally
    venv-create  # Create and source the python environment

How to Build MKDocs

just build

all the outputs will be in site folder.

How to Build MKDocs incrementally

just serve

all the outputs will be in site folder. Open the webpagehttp://127.0.0.1:8000/tschinz/znotes/

Continuous Integration (CI)

The CI is done with Github Actions with the file action-mkdocs.yml will run on each master commit and create a site/ folder which will be pushed onto the branch gh-pages and consequently be used by github to displayed static html pages.