Docs Site: https://docs/ombi.app
This is the source repository for the upcoming Ombi Docs site. The intent is to replace the aging wiki with something a little more... professional. It is very much a work in progress at this point.
The easiest method to install mkdocs is via python - it's consistent across different OS environments.
Install Python for your OS, ensuring that it gets added to PATH.
Once you have Python installed, you'll need to clone the repository and install the python packages used by this site (like mkdocs itself).
To do this, clone the repo, and from the relevant terminal/shell/prompt, change directory to the repo folder and run
pip install -r docs/requirements.txt
to ensure you have all the relevant packages for use.
To edit the site content, edit the markdown files under "docs".
To edit the site layout, edit the mkdocs.yml file (held in the root directory).
Note that as mkdocs.yml is written in an indent-sensitive language, the new documentation repository is not going to be directly publicly editable - all edit requests will need to go through approval by submitting a pull request.
VS Code is a good option to use for this, as it has extensions for markup and markdown syntax highlighting (as well as preview functions).
Atom is another good option.
For doing code standards checking (a.k.a. 'linting'):
DavidAnson.vscode-markdownlint
For syntax highlighting and preview functions:
yzhang.markdown-all-in-one
The site is being built using mkdocs, which converts standard markdown to static html.
mkdocs itself can be told to 'serve' the folder by opening the folder containing mkdocs.yml in your relevant console/terminal and running mkdocs serve.
This will let you live preview the site in your browser, with changes being updated any time you save an edit to a file.