Skip to content

HsiangAnYu/wtfdocs

This branch is 5 commits behind wtfutil/wtfdocs:master.

Repository files navigation

WTF Docs

This site is built using Material for MkDocs.

Development environment setup

  1. Install python 3
  2. Create a virtual-env:
python -m venv virtual-env
source virtual-env/bin/activate
  1. pip install -r requirements.txt
  2. mkdocs serve

To add documentation for a new module

  1. Create a new Markdown file in the /docs/modules directory
  2. Add a new route in the mkdocs.yml file, under the nav: section.
  3. To add pictures, add the image to ./docs/overrides/assets/modules/<IMAGE>.png

Deploying

  • Merge changes into master
  • Run mkdocs gh-deploy --force to push the changes to the gh-pages branch on github.com
  • Commit the resulting changes into master

Releases

No releases published

Packages

No packages published

Languages

  • HTML 99.6%
  • JavaScript 0.4%