README.md

• What is DDEV Mkdocs Add-on?
• Getting started
• Using mkdocs
  • Configuration
  • Write your own documentation
  • View the documentation

What is DDEV Mkdocs Add-on?

his repository provides a DDEV add-on for the mkdocs service, based on Metadrop mkdocs docker image.

MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.

This addon just provides the basics to view mkdocs static site from docs/ folder on your project.

Getting started

Install this addon with

ddev get Metadrop/ddev-mkdocs

After that you need to restart the ddev project:

ddev restart

Using mkdocs

Configuration

By default, mkdocs addon show docs from /docs folder inside yout project. This can be updated in docker-compose.mkdocs.yaml as needed.

Also this addon uses ports 9004 and 9005 to view documentation, this can be updated in docker-compose.mkdocs.yaml too.

Write your own documentation

To start building your docs you can read the Mkdocs getting started guide and for more advanced functionalities here is the Mkdocs user guide.

View the documentation

Mkdocs documentation can be accesed in https://${PROJECT_NAME}.ddev.site:9005