This repository allows you to quickly install MKdocs into a DDEV project using just ddev get nireneko/ddev-mkdocs
.
ddev get nireneko/ddev-mkdocs
ddev restart
MKdocs will now be accessible from http://<project>.ddev.site:8001
This MKdocs recipe for DDEV installs a .ddev/docker-compose.mkdocs.yaml
using the squidfunk/mkdocs-material
Docker image.
This package creates one folder named mkdocs
in the root of your project and inside mkdocs.yml file, you can add the configuration that you need for your project.
Inside the folder mkdocs
another one named docs
also will be created, there you can put your documentation, one example file index.md
is available.
Check the official documentation of MKdocs and the documentation of MKdocs Material for more information about the configuration and page creation.
Contributed and maintained by @nireneko based on the original ddev-contrib template.