bitumdocs is source code for the Bitum project documentation.
bitumdocs is built with MkDocs - a documentation toolkit written in Python.
In order to develop on
bitumdocs you will need Python installed on your system. Version 3.7 is recommended because this is the version used by the live site, however MkDocs does also support versions 2.7, 3.4, 3.5 and 3.6.
You can verify your installation of Python by checking the output from these two commands:
$ python --version Python 3.7.0 $ pip --version pip 18.0
To install MkDocs and all of the other Python libraries required by
$ pip install --user -r requirements.txt
This repo contains a single configuration file named
mkdocs.yml, and a folder named
docs that will contain the documentation source files. MkDocs comes with a built-in dev-server that lets you preview the documentation as you work on it. Make sure you are in the same directory as the
mkdocs.yml configuration file, and then start the server by running the
mkdocs serve command:
$ mkdocs serve INFO - Building documentation... INFO - Cleaning site directory [I 160402 15:50:43 server:271] Serving on http://127.0.0.1:8000 [I 160402 15:50:43 handlers:58] Start watching changes [I 160402 15:50:43 handlers:60] Start detecting changes
If you are using Windows, you may need to inform python to search sys.path for the mkdocs module:
$ python -m mkdocs serve INFO - Building documentation... INFO - Cleaning site directory [I 190207 18:05:35 server:298] Serving on http://127.0.0.1:8000 [I 190207 18:05:35 handlers:59] Start watching changes [I 190207 18:05:35 handlers:61] Start detecting changes
Open up http://127.0.0.1:8000 in your browser, and you will see the documentation home page being displayed. The dev-server also supports auto-reloading, and will rebuild your documentation whenever anything in the configuration file or the documentation directory changes.
bitumdocs, first build the documentation:
This will build the documentation into a new directory named
The version of
bitumdocs that you just built only uses static files which are all contained within the
site/ directory, so this directory can be hosted using almost any web server software.
bitumdocs can also be built and hosted in a Docker container. Build the container using:
The container can then be run with:
$ docker run -d --rm -p <local port>:80 bitum/bitumdocs:latest
Pages to review upon new releases