Convert .md file to HTML documentation

In order to install MkDocs 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 --version
Python 2.7.2
$ pip --version
pip 1.5.2

Install the mkdocs package using pip:

$ pip install mkdocs

Getting started is super easy.

$ mkdocs new my-project
$ cd my-project

Let's take a moment to review the initial project that's created for us.

MkDocs comes with a built-in web server that lets you preview your documentation as you work on it. We start the web server by making sure we're in the same directory as the mkdocs.yml config file, and then running the mkdocs serve command:

$ mkdocs serve
Running at: http://127.0.0.1:8000/

Ref: http://www.mkdocs.org/

results matching ""

    No results matching ""