All Implemented Interfaces and Traits:

org.gradle.api.Plugin

@groovy.transform.CompileStatic
class MkdocsPlugin
extends java.lang.Object

Mkdocs plugin. Provides tasks:

• mkdocsInit - create documentation site
• mkdocsBuild - build site
• mkdocsServe - start livereload server (for development)
• mkdocsPublish - publish generated site to github pages (same repo)

mkdocksInit not use 'mkdocs new', instead more advanced template used with pre-initialized material theme.

mkdocsPublish is a custom task (based on git-publish plugin). This is because native 'mkdocs publish' only support single documentation version and custom task will manage multi-version documentation site.

Plugin will also apply all required pip modules to use mkdocks with material theme and basic plugins (see MkdocsExtension.DEFAULT_MODULES).

Authors:

Vyacheslav Rusakov

Since:

29.10.2017