Gradle Mkdocs plugin

Additional

Language
Groovy
Version
1.1.0 (Oct 15, 2018)
Created
Dec 20, 2017
Updated
Oct 15, 2018
Owner
Vyacheslav Rusakov (xvik)
Contributor
Vyacheslav Rusakov (xvik)
1
Activity
Badge
Generate
Download
Source code

Promotion

Gradle Mkdocs plugin

DOCUMENTATION https://xvik.github.io/gradle-mkdocs-plugin/

About

Generates project documentation with Mkdocs python tool.

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)
  • Multi-version documentation publishing to github pages
Summary
  • Configuration: mkdocs
  • Tasks:
    • mkdocsInit - generate initial site
    • mkdocsServe - livereload server (dev)
    • mkdocsBuild - build documentation
    • mkdocsPublish - publish to github pages
    • type:MkdocsTask to call custom mdocs commands
  • Enable plugins: git-publish, use-python

Setup

Releases are published to bintray jcenter, maven central and gradle plugins portal.

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'ru.vyarus:gradle-mkdocs-plugin:1.1.0'
    }
}
apply plugin: 'ru.vyarus.mkdocs'

OR

plugins {
    id 'ru.vyarus.mkdocs' version '1.1.0'
}

Python

Requires installed python 2.7 or 3.4 and above with pip.

Check and install python if required.

Usage

Read documentation

Might also like