Mkdocs Simple Generator

mkdocs_simple_gen is a program that will automatically create a mkdocs.yml configuration file (only if needed) and optionally install dependencies, build, and serve the site.

Installation

Install the plugin with pip.

pip install mkdocs-simple-plugin

Python 3.x, 3.8, 3.9, 3.10, 3.11 supported.

CLI Reference

mkdocs_simple_gen

Generate and build a mkdocs site.

Usage:

mkdocs_simple_gen [OPTIONS] [MKDOCS_ARGS]...

Options:

  --config-file TEXT    Set the configuration file.
  --build / --no-build  Build the site using mkdocs build.
  --serve / --no-serve  Serve the site using mkdocs serve.
  --help                Show this message and exit.