Good resources to become a Developer
Markdown documentation project
QB documentation project is based on MkDocs and written in Markdown. It is configured in a single YAML
configuration file.
Getting started is super easy.
In order to install QB Docs you’ll need Python installed on your system, as
well as the Python package manager, pip. You can check if you have these
already installed like so:
$ python --versionPython 2.7.2$ pip --versionpip 1.5.2
Install the mkdocs package using pip install mkdocs
You should now have the mkdocs command installed on your system. Run mkdocs --version to check that everything worked okay.
git clone git@gitlab.com:tostasqb/qb-docs.gitcd qb-docs
There’s a single configuration file named mkdocs.yml, and a folder nameddocs that will contain our documentation source files.
QB Docs comes with a built-in webserver that lets you preview your documentation
as you work on it. We start the webserver by making sure we’re in the same
directory as the mkdocs.yml config file, and then running the mkdocs serve
command:
$ mkdocs serveRunning at: http://127.0.0.1:8000/
Open up http://127.0.0.1:8000/ in your browser, and
you’ll see the index page being displayed.
The webserver also supports auto-reloading, and will rebuild your documentation
whenever anything in the configuration file, documentation directory or theme
directory changes.
Add a page into de docs folder with an .md
Add the link into the mkdocs.yml
mkdocs build
This will create a new directory, named site.
After some time, files may be removed from the documentation but they will still
reside in the site directory. To remove those stale files, just run mkdocs
with the --clean switch.
mkdocs build --clean
When ready, submit a pull request and once accepted it will be ‘automagically’ published on docs.tostasqb.com