项目作者: tostasqb

项目描述 :
Good resources to become a Developer
高级语言:
项目地址: git://github.com/tostasqb/qb-docs.git
创建时间: 2016-04-05T12:13:46Z
项目社区:https://github.com/tostasqb/qb-docs

开源协议:

下载


Build Status

qb-docs

Markdown documentation project


Overview

QB documentation project is based on MkDocs and written in Markdown. It is configured in a single YAML
configuration file.


Getting started

Getting started is super easy.

Install Python

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:

  1. $ python --version
  2. Python 2.7.2
  3. $ pip --version
  4. pip 1.5.2

Installing MkDocs

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.

Install qb-docs

  1. git clone git@gitlab.com:tostasqb/qb-docs.git
  2. cd qb-docs

There’s a single configuration file named mkdocs.yml, and a folder named
docs 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:

  1. $ mkdocs serve
  2. Running 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.

Adding pages

Add a page into de docs folder with an .md
Add the link into the mkdocs.yml

Building the site (HTML Output)

  1. 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.

  1. mkdocs build --clean

Online documentation

When ready, submit a pull request and once accepted it will be ‘automagically’ published on docs.tostasqb.com

Credits