Skip to content

Booster-Bot-Discord/mkdocs-boosterbot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BoosterBot Docs

This repository will have raw md source of docs for booster bot.

References:

Project setup

  1. Install pip on your device.
  2. Install Material for MkDocs with pip command: pip install mkdocs-material
  3. mkdocs serve - Start the live-reloading docs server.

Info: mkdocs -h - Print help message and exit.

How to contribute?

  • You can create an issue of what's missing that you want to add or want us to add OR check existing issues and find some suggestions by others that you can work on and contribute.
  • Once you've assigned any issue, you can make changes and raise a pull request against dev branch. Reference PR: #1

Join support server for more info: https://boosterbot.xyz/support

Other MkDocs Commands

  • mkdocs new [dir-name] - Create a new project.
  • mkdocs serve - Start the live-reloading docs server.
  • mkdocs build - Build the documentation site.
  • mkdocs -h - Print help message and exit.

Use python -m mkdocs serve (or other commands with python -m prefix) if The term 'mkdocs' is not recognized error pops up.