- You can either install mkdocs from pip or from a virtual environment.
- It's highly recommended to use a virtual environment and not pip, so that the dependencies of this project won't mess with your system-wide python packages / modules. You still need to use pip to install pipenv though ;).
- Personnally I am using pipenv, which you install on openSUSE distributions with:
pip3 install --user pipenv. Then you'll need to add~/.local/binto your PATH. The best method for that depends on your shell. - Then
- clone this repo where you want in your home folder
cdto it and runpipenv installto install the dependencies, and thenpipenv shellto run the environment.- finally
cdtoprojectand run youmkdocscommands from there, i.e.mkdocs buildto generate the web content andmkdocs serveto serve it (by default at http://127.0.0.1:8000/).
- Available commands & documentation on mkdocs: https://www.mkdocs.org/
- The default branch -- the working branch -- is not
mainormasterbutdev. That's the branch where day-to-day work should happen. masterenforces the some basic rules, bear them in mind if something is not working as expected:- Require pull request reviews before merging
- Require status checks to pass before merging
- Require branches to be up to date before merging