https://github.com/wtfutil/wtfdocs

The source for https://wtfutil.com
https://github.com/wtfutil/wtfdocs

hacktoberfest mkdocs wtf wtfutil

Last synced: about 1 month ago
JSON representation

The source for https://wtfutil.com

• Host: GitHub
• URL: https://github.com/wtfutil/wtfdocs
• Owner: wtfutil
• Created: 2018-10-09T17:30:23.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-21T21:03:24.000Z (8 months ago)
• Last Synced: 2024-11-17T10:02:52.801Z (about 2 months ago)
• Topics: hacktoberfest, mkdocs, wtf, wtfutil
• Language: HTML
• Homepage:
• Size: 28.6 MB
• Stars: 33
• Watchers: 3
• Forks: 75
• Open Issues: 22
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# WTF Docs

This site is built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).

### Development environment setup

1. Install python 3

2. Create a virtual-env:

```bash

python -m venv virtual-env

source virtual-env/bin/activate

```

3. `pip install -r requirements.txt`

4. `mkdocs serve`

### To add documentation for a new module

1. Create a new [Markdown](https://guides.github.com/features/mastering-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/.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`