Quickstart

Installation

apt install mkdocs

For more details, see the Installation Guide.

Creating a new project

To create a new project (from a built-in template), run the following command from the command line:

mkdocs new my-project
cd my-project

For a quick preview, start the built-in dev-server. Make sure you're in the same directory as the mkdocs.yml configuration file, and then start the server by running the mkdocs serve command:

mkdocs serve

Open up http://127.0.0.1:8000/ in your browser, and you'll see the default home page being displayed