Tomahna Project Wiki

This is the source repository for the project wiki.

Visit the wiki here.

Editing the Wiki

Edit the pages inside the docs folder to add or change information.

This wiki makes use of MkDocs. When editing the wiki, you should locally build it to ensure there are no errors.

This requires Python. Run the following command to install all required dependencies:

pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-htmlproofer-plugin

Running mkdocs serve starts up a server at 127.0.0.1:8000 with the docs site. Use this for testing.

MkDocs reference for writing document pages.

Material for MkDocs reference

Reference for how these pages were setup, and how you can edit and view the wiki locally before pushing edits can be found in this video