Gradle Mkdocs plugin

Additional

Language
Groovy
Version
2.0.1 (Apr 6, 2020)
Created
Dec 20, 2017
Updated
Apr 6, 2020
Owner
Vyacheslav Rusakov (xvik)
Contributors
Will Sargent (wsargent)
Vyacheslav Rusakov (xvik)
2
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

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

OR

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

Compatibility

Plugin compiled for java 8, compatible with java 11

Gradle Version
5-6 2.0.1
4.x 1.1.0

Requires installed python 2.7 or 3.4 and above with pip.

Check and install python if required.

Snapshots

Snapshots may be used through JitPack
  • Go to JitPack project page
  • Select Commits section and click Get it on commit you want to use or use master-SNAPSHOT to use the most recent snapshot

For gradle before 6.0 use buildscript block with required commit hash as version:

buildscript {
    repositories {
        maven { url 'https://jitpack.io' }
    }
    dependencies {
        classpath 'ru.vyarus:gradle-mkdocs-plugin:2450c7e881'
    }
}
apply plugin: 'ru.vyarus.mkdocs'

For gradle 6.0 and above:

  • Add to settings.gradle (top most!) with required commit hash as version:

    pluginManagement {
        resolutionStrategy {
            eachPlugin {
                if (requested.id.namespace == 'ru.vyarus.mkdocs') {
                    useModule('ru.vyarus:gradle-mkdocs-plugin:2450c7e881')
                }
            }
        }
        repositories {
            maven { url 'https://jitpack.io' }
            gradlePluginPortal()          
        }
    }    
  • Use plugin without declaring version:

    plugins {
        id 'ru.vyarus.mkdocs'
    }

Usage

Read documentation

Might also like