mkdocs

generates documentation websites

TLDR

Create new project

$ mkdocs new [project-name]

Serve locally

$ mkdocs serve

Build site

$ mkdocs build

Deploy to GitHub Pages

$ mkdocs gh-deploy

Serve on custom port

$ mkdocs serve -a [localhost:8080]

Strict mode

$ mkdocs build --strict

SYNOPSIS

mkdocs command [options]

DESCRIPTION

mkdocs generates documentation websites. It builds static sites from Markdown files.The tool is designed for project documentation. Supports themes and plugins.

PARAMETERS

COMMAND

MkDocs operation.

new NAME

Create new project.

serve

Start dev server.

build

Build static site.

gh-deploy

Deploy to GitHub Pages.

-a ADDR

Server address.

--help

Display help information.

INSTALL

sudo dnf install mkdocs

sudo pacman -S mkdocs

sudo apk add mkdocs

brew install mkdocs

nix profile install nixpkgs#mkdocs

CAVEATS

Python-based. Requires mkdocs.yml config. Material theme popular.

HISTORY

MkDocs was created to provide simple, fast documentation generation from Markdown files.