Welcome to gradle-mkdocs-plugin

Mkdocs (python tool) documentation generation and publishing plugin

Release notes - Migration notes - License

Ideal for open source projects

• Easy start: initial docs source generation
• Markdown syntax (with handy extensions)
• Great look from material theme (used by default) with extra features:
  • Mobile friendly
  • Embedded search
  • Syntax highlighting
  • Dark theme switcher
• Easy documentation contribution (jump to source directly from doc)
• Multi-version documentation publishing to github pages
  • Support version aliases (latest, dev, etc)
  • Support mkdocs-material version switcher without mike tool usage
• Variables support
• Could work with direct python or docker.
• Could use requirements.txt file

Common configurations (cheat sheet)

Example usages:

• mkdocs-gradle-plugin (self)
• use-python-gradle-plugin (base plugin)
• dropwizard-guicey
• gradle-quality-plugin