Skip to content

How to install Mkdocs

Install Python

Install Python (and many libraries) via Anaconda

Install Mkdocs

  • Download requirements.txt.
  • Launch Anaconda Prompt.

  • Execute:

    pip install virtualenv
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt

  • It should install a few packages, e.g.:

    • mkdocs
    • mkdocs-awesome-pages-plugin
    • mkdocs-localsearch
    • mkdocs-material
    • mkdocs-material-extensions
    • mkdocs-print-site-plugin
    • pymdown-extensions

More info on https://www.mkdocs.org

Create a test project with MkDocs

In a terminal:

  • cd Desktop
  • mkdocs new TestProject
  • cd TestProject
  • mkdocs serve

Open http://localhost:8000/ in your browser.

  • Edit mkdocs.yml file.
  • Add Markdown files in docs/ folder
  • Add sub-folder in docs/ folder
  • They should appear automatically in http://localhost:8000/

Work on SimStadt documentation

  • Install Markdown editor
  • Install MkDocs + Plugins
  • Get simstadt_doc
    • Create SSH key if needed
    • Send it to Eric
    • git clone git@dmz15.rz.hft-stuttgart.de:simstadt_doc