Yonder Deep Wiki

How to Contribute

Setup

Required: Pip, Python 3.X.X, git

1. Install MkDocs

pip install mkdocs-material
pip install -e mkdocs-material

2. Clone Wiki Repository

git clone [email protected]:Yonder-Deep/YD-Docs.git
cd YD-DOCS

Run Local

• To build a local version of the site:

mkdocs serve

Local Wiki should start at https://localhost:8000

• Build after editing

mkdocs build

Editing

Individual pages are simply edited directly on their markdown files. New pages should be added under /docs/.

• Add reference to the mkdocs.yml file