Search Gradle plugins

synapticloop.documentr

Owner: synapticloop

documentation (README.md) generator for projects

https://github.com/synapticloop/documentr

Sources: https://github.com/synapticloop/documentr

Version 3.1.0 (latest)

Created 03 April 2020.

This plugin version will no longer resolve after JCenter becomes a permanent redirect to Maven Central as it uses dependencies only found in JCenter. See the following blog post for details: https://blog.gradle.org/portal-jcenter-impact documentation (README) generator for projects in both markdown and asciidoc - this utilises the templar templating language
Other versions 

Add this plugin to your build using the plugins DSL:

plugins {
  id("synapticloop.documentr") version "3.1.0"
}

See also:

  • Adding the plugin to build logic for usage in precompiled script plugins.

    See the relevant documentation for more information.

    Add this plugin as a dependency to <convention-plugins-build>/build.gradle(.kts):

    dependencies {
  implementation("synapticloop.documentr:synapticloop.documentr.gradle.plugin:3.1.0")
}
    It can then be applied in the precompiled script plugin:
    plugins {
  id("synapticloop.documentr")
}
  • The legacy method of plugin application. See the relevant documentation for more information. 
    buildscript {
  repositories {
    gradlePluginPortal()
  }
  dependencies {
    classpath("synapticloop.documentr:synapticloop.documentr.gradle.plugin:3.1.0")
  }
}

apply(plugin = "synapticloop.documentr")
  • Applying plugins to all subprojects .