MkDocs⚑

MkDocs is a Markdown conversion tool written using Python, which provides the ability to quickly convert Markdown text files to Web pages.

Installation⚑

mkdocs is a Python library and can be installed via pip, Python's package manager.

pip install mkdocs

Installing Python and pip⚑

Install Python using your package manager of choice, or by downloading an installer appropriate for your system from python.org and running it.

If you are installing Python on Windows, be sure to check the box to have Python added to your PATH if the installer offers such an option (it's normally off by default).

![Add Python to PATH](https://www.mkdocs.org/img/win-py-install.png)

If you're using a recent version of Python, the Python package manager, pip, is most likely installed by default. However, you may need to upgrade pip to the lasted version:

pip install --upgrade pip

If you need to install pip for the first time, download get-pip.py. Then run the following command to install it:

python get-pip.py

If you would like manpages installed for MkDocs, the [click-man](https://github.com/click-contrib/click-man) tool can generate and install them for you. Simply run the following two commands:

pip install click-man
click-man --target path/to/man/pages mkdocs

See the click-man documentation for an explanation of why manpages are not automatically generated and installed by pip.

If you are using Windows, some of the above commands may not work out-of-the-box.

A quick solution may be to preface every Python command with `python -m` like this:

`python -m pip install mkdocs`
`python -m mkdocs`

For a more permanent solution, you may need to edit your `PATH` environment variable to include the `Scripts` directory of your Python installation. Recent versions of Python include a script to do this for you. Navigate to your Python installation directory (for example `C:\Python38\`), open the `Tools`, then `Scripts` folder, and run the `win_add2path.py` file by double clicking on it. Alternatively, you can download the [script](https://github.com/python/cpython/blob/master/Tools/scripts/win_add2path.py) and run it (`python win_add2path.py`).

Commands⚑

• mkdocs new <project> - Creates a new project catalog/directory
• mkdocs serve - Starts a web host that automatically detects file changes and re-loads
• mkdocs build - Set up a website to generate static web files
• mkdocs help - Shows a description message

Structure⚑

mkdocs.yml # configuration file

---

Links:

Sources: - mkdocs.org - GitHub - mkdocs/mkdocs: Project documentation with Markdown.