About This Documentation
The documentation you are currently reading was written using mkdocs. It is a tool that will generate a static website based on markdown files. Markdown has the advantage that it is simple to read and write, and that there are several tools that can translate a markdown file into languages like HTML or LaTeX.
- Download the latest Python3 version.
- When running the setup program, make sure to tick, "Add Python 3.x to PATH".
- Install Python.
- Open PowerShell or cmd.exe and type:
pip3 install mkdocs.
MacOS already includes Python, however, pip is still missing. The easiest and most nondestructive way is to install the MacOS package manager, homebrew, first. The advantage of homebrew is that it will only modify your home directory, and not the root dir, so your OS will not be tampered with.
- Install homebrew.
- Install Python from homebrew, which will also install pip. Enter this command:
brew install python.
- Install mkdocs:
pip3 install mkdocs
Linux/*BSD also has Python preinstalled. Most distributions also contain pip by default. If it is not installed, you may need to figure out how to install pip3 through the package manager of your system.
- Install pip3 with these commands according to distributions:
apt install python3-pip
sudo dnf install python3-pip
sudo pacman -S python-pip
sudo zypper install python-pip
- *BSD: You are already advanced enough to know how you can force the bits on your disk to become pip by meditating upon it.
pip3 install mkdocsto install mkdocs only for the current user, or run
sudo pip3 install mkdocsto install mkdocs systemwide. Last one has the higher chance to work properly.
This might sound funny, but according to the growing amount of Chromebooks and Android tablets with keyboards, this might actually be useful.
- Install the Termux App from f-droid.
- Launch Termux and type
- Install Python and git with the command:
apt install git python
- Install mkdocs with
pip install mkdocs.
From herein, everything will be the same as on Desktop. If you want to edit the files, you can (besides vim or emacs which are available through Termux) use your preferred text editor on Android. This is possible by opening the files with the Termux integration of the build in android file manager:
Sometimes, mkdocs changes the way of how it serves, or the syntax will differ. This is why you should make sure to always run the latest version of mkdocs. To check, simply run
pip3 install --upgrade mkdocs or
sudo pip3 install --upgrade mkdocs if you installed pip system wide on a Linux/BSD* system.
In order to extend this documentation, you have to clone it from its GitHub repository. When you clone it, you will find a mkdocs.yml file, and a docs directory inside. The yaml file is the config file while in the directory docs the documentation files are stored. Here is a guide about how to use mkdocs.
Write and Deploy
If you are writing a documentation page and want a live preview of it, you can enter the root directory of this documentation project, and then run
mkdocs serve this will start the mkdocs internal web server on port
8000. So all you have to do is type
localhost:8000 into the address bar of your browser, and here you go. If you modify a file, and save it, mkdocs will reload the page and show you the new content.
If you want to deploy the page so it will be up to date at the GitHub pages, simply type
mkdocs gh-deploy. However, please be aware that this will not push your changes to the
master branch of the repository. So, you still have to commit and push your changes to the actual git repository of this documentation. Please be aware that only privileged maintainers can do this.