Skip to content

Welcome to gradle-mkdocs-plugin

Mkdocs (python tool) documentation generation and publishing plugin

Release 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
  • Easy documentation contribution (jump to source directly from doc)
  • Multi-version documentation publishing to github pages

Example usages: