Installation ¶
All plugins are part of this package and cannot be installed separately, but not all of them have to be enabled.
Publisher for MkDocs is a Python package that can be installed using
pip
(ideally inside a virtual environment) or any other package manager like
poetry
that handles virtual management out of the box.
This package depends on some other Python packages and MkDocs plugins, so during installation they will also be installed. List of them:
- MkDocs ,
- Material for MkDocs - (probably) the best theme for MkDocs,
- PyMdown Extensions - extensions for Markdown language.
There are also some external tools used, mostly by
pub-minifier
plugin. Since this plugin is part of this package, but it's optional to use (not enabled by default), the process of installation of those tools is described in this
plugin installation
.
Backlinks:
First steps
Currently, please take a look at installation and each plugin configuration section of this documentation.