MkDocs Material
Notes
Commands
mkdocs new [dir-name]
- Create a new project.mkdocs serve
- Start the live-reloading docs server.mkdocs build
- Build the documentation site.mkdocs -h
- Print help message and exit.
Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
Admonition Examples
!!! note "This is a note"
Valid keywords:
```
note abstract info tip success question
warning failure danger bug quote
```
This is a note
Valid keywords:
How to make an Admonition collapsible.
??? Make it collapsible.
abstract
tip
success
question
warning
failure
danger
bug
quote
Advanced Example
??? question "How to add plugins to the Docker image?"
Material for MkDocs only bundles selected plugins in order to keep the size
of the official image small. If the plugin you want to use is not included,
you can add them easily:
=== "Material for MkDocs"
Create a `Dockerfile` and extend the official image:
``` Dockerfile title="Dockerfile"
FROM squidfunk/mkdocs-material
RUN pip install mkdocs-macros-plugin
RUN pip install mkdocs-glightbox
```
=== "Insiders"
Clone or fork the Insiders repository, and create a file called
`user-requirements.txt` in the root of the repository. Then, add the
plugins that should be installed to the file, e.g.:
``` txt title="user-requirements.txt"
mkdocs-macros-plugin
mkdocs-glightbox
```
Next, build the image with the following command:
```
docker build -t squidfunk/mkdocs-material .
```
The new image will have additional packages installed and can be used
exactly like the official image.
How to add plugins to the Docker image?
Material for MkDocs only bundles selected plugins in order to keep the size of the official image small. If the plugin you want to use is not included, you can add them easily:
Create a Dockerfile
and extend the official image:
Next, build the image with the following command:
The new image will have additional packages installed and can be used exactly like the official image.
End
note note note note