Package io.freefair.gradle.plugins.mkdocs

Class MkDocsPlugin

java.lang.Object
io.freefair.gradle.plugins.mkdocs.MkDocsPlugin
All Implemented Interfaces:
Plugin<Project>
public class MkDocsPlugin extends Object implements Plugin<Project>
Gradle plugin for MkDocs documentation generator.

Provides tasks to build, serve, and package MkDocs-based documentation. Requires MkDocs to be installed and available on the system PATH.

This plugin registers the following tasks:

  • mkdocs - Builds the documentation
  • mkdocsServe - Starts the development server
  • mkdocsNew - Creates a new MkDocs project
  • mkdocsZip - Creates a ZIP archive of the built documentation
  • mkdocsTar - Creates a TAR archive of the built documentation

  • Constructor Details

    • MkDocsPlugin

      public MkDocsPlugin()

  • Method Details