{"id":22707684,"url":"https://github.com/xvik/gradle-mkdocs-plugin","last_synced_at":"2025-06-21T01:34:49.362Z","repository":{"id":38375677,"uuid":"114878147","full_name":"xvik/gradle-mkdocs-plugin","owner":"xvik","description":"Mkdocs documentation generation and publishing plugin","archived":false,"fork":false,"pushed_at":"2025-01-31T04:27:53.000Z","size":2768,"stargazers_count":40,"open_issues_count":1,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-13T12:38:24.717Z","etag":null,"topics":["documentation","github-pages","gradle","gradle-plugin","markdown","mkdocs","mkdocs-material"],"latest_commit_sha":null,"homepage":"https://xvik.github.io/gradle-mkdocs-plugin/","language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xvik.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-12-20T11:12:36.000Z","updated_at":"2025-02-09T11:03:05.000Z","dependencies_parsed_at":"2023-11-18T06:24:41.944Z","dependency_job_id":"db4e0159-e371-4f4f-bb4b-c446fb7b9abe","html_url":"https://github.com/xvik/gradle-mkdocs-plugin","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/xvik/gradle-mkdocs-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-mkdocs-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-mkdocs-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-mkdocs-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-mkdocs-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xvik","download_url":"https://codeload.github.com/xvik/gradle-mkdocs-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xvik%2Fgradle-mkdocs-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261046786,"owners_count":23102332,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","github-pages","gradle","gradle-plugin","markdown","mkdocs","mkdocs-material"],"created_at":"2024-12-10T10:13:49.542Z","updated_at":"2025-06-21T01:34:44.345Z","avatar_url":"https://github.com/xvik.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gradle Mkdocs plugin\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](http://www.opensource.org/licenses/MIT)\n[![CI](https://github.com/xvik/gradle-mkdocs-plugin/actions/workflows/CI.yml/badge.svg)](https://github.com/xvik/gradle-mkdocs-plugin/actions/workflows/CI.yml)\n[![Appveyor build status](https://ci.appveyor.com/api/projects/status/github/xvik/gradle-mkdocs-plugin?svg=true)](https://ci.appveyor.com/project/xvik/gradle-mkdocs-plugin)\n[![codecov](https://codecov.io/gh/xvik/gradle-mkdocs-plugin/branch/master/graph/badge.svg)](https://codecov.io/gh/xvik/gradle-mkdocs-plugin)\n\n**DOCUMENTATION** https://xvik.github.io/gradle-mkdocs-plugin/\n\n### About\n\nGenerates project documentation with [Mkdocs](http://www.mkdocs.org/) python tool. \n\nIdeal for open source projects:\n\n* Easy start: initial docs source generation\n* Markdown syntax (with handy extensions)\n* Great look from [material theme](https://squidfunk.github.io/mkdocs-material/) (used by default) with extra features:\n    - Mobile friendly\n    - Embedded search\n    - Syntax highlighting\n    - Dark theme switcher\n* Easy documentation contribution (jump to source)\n* Multi-version documentation publishing to github pages \n    - Support version aliases (latest, dev, etc)\n    - Support mkdocs-material version switcher without mike tool usage\n* Variables support\n* Could work with direct python or docker.\n* Could use requirements.txt file\n* Compatible with gradle configuration cache\n\n##### Summary\n\n* `mkdocs-build` plugin:\n  - Configuration: `mkdocs`\n  - Tasks:\n      - `mkdocsInit` - generate initial site \n      - `mkdocsServe` - livereload server (dev)\n      - `mkdocsBuild` - build documentation  \n      - `type:MkdocsTask` to call custom mkdocs commands\n    \n* `mkdocs` plugin adds:\n  - Configuration: `gitPublish`\n  - Tasks:\n      - `gitPublishReset` - checkout repository\n      - `mkdocsVersionsFile` - generate versions.json file for version switcher\n      - `gitPublishCopy` - copy (and add) files into repository\n      - `gitPublishCommit` - commit updates into repository\n      - `gitPublishPush` - push commit\n      - `mkdocsPublish` - publish to github pages (main task)\n    \n* Enable plugins: [use-python](https://github.com/xvik/gradle-use-python-plugin)\n\nNOTE: plugin is based on [use-python plugin](https://github.com/xvik/gradle-use-python-plugin) see python-specific \ntasks there.  \n\n### Setup\n\n[![Maven Central](https://img.shields.io/maven-central/v/ru.vyarus/gradle-mkdocs-plugin.svg)](https://maven-badges.herokuapp.com/maven-central/ru.vyarus/gradle-mkdocs-plugin)\n[![Gradle Plugin Portal](https://img.shields.io/maven-metadata/v/https/plugins.gradle.org/m2/ru/vyarus/mkdocs/ru.vyarus.mkdocs.gradle.plugin/maven-metadata.xml.svg?colorB=007ec6\u0026label=plugins%20portal)](https://plugins.gradle.org/plugin/ru.vyarus.mkdocs)\n\n```groovy\nbuildscript {\n    repositories {\n        mavenCentral()\n    }\n    dependencies {\n        classpath 'ru.vyarus:gradle-mkdocs-plugin:4.0.1'\n    }\n}\napply plugin: 'ru.vyarus.mkdocs'\n```\n\nOR \n\n```groovy\nplugins {\n    id 'ru.vyarus.mkdocs' version '4.0.1'\n}\n```\n\n#### Lightweight setup\n\nThere is also a lightweight plugin version without publication tasks:\n\n```groovy\nplugins {\n    id 'ru.vyarus.mkdocs-build' version '4.0.1'\n}\n```\n\nLightweight plugin is suitable if you don't need git publication and don't want extra\ntasks to appear.\n\n#### Compatibility\n\nPlugin compiled for java 8, compatible with java 11.\n\nGradle | Version\n--------|-------\n7.0     | 4.0.1\n5.3     | [3.0.0](https://xvik.github.io/gradle-mkdocs-plugin/3.0.0/)\n5-5.2   | [2.3.0](https://xvik.github.io/gradle-mkdocs-plugin/2.3.0/)\n4.x     | [1.1.0](https://github.com/xvik/gradle-mkdocs-plugin/tree/1.1.0)\n\n**Requires installed python** 3.8 and above with pip.\n\n[Check and install python if required](https://xvik.github.io/gradle-use-python-plugin/2.3.0/guide/python/).\n\n\n#### Snapshots\n\n\u003cdetails\u003e\n      \u003csummary\u003eSnapshots may be used through JitPack\u003c/summary\u003e\n\n* Go to [JitPack project page](https://jitpack.io/#ru.vyarus/gradle-mkdocs-plugin)\n* Select `Commits` section and click `Get it` on commit you want to use \n    or use `master-SNAPSHOT` to use the most recent snapshot\n\n* Add to `settings.gradle` (top most!) (exact commit hash might be used as version):\n\n  ```groovy\n  pluginManagement {\n      resolutionStrategy {\n          eachPlugin {\n              if (requested.id.id == 'ru.vyarus.mkdocs') {\n                  useModule('ru.vyarus:gradle-mkdocs-plugin:master-SNAPSHOT')\n              }\n          }\n      }\n      repositories {                        \n          gradlePluginPortal()\n          maven { url 'https://jitpack.io' }                    \n      }\n  }    \n  ``` \n* Use plugin without declaring version: \n\n  ```groovy\n  plugins {\n      id 'ru.vyarus.mkdocs'\n  }\n  ```  \n\n\u003c/details\u003e  \n\n\n### Usage\n\nRead [documentation](https://xvik.github.io/gradle-mkdocs-plugin/)\n\n### Might also like\n\n* [quality-plugin](https://github.com/xvik/gradle-quality-plugin) - java and groovy source quality checks\n* [animalsniffer-plugin](https://github.com/xvik/gradle-animalsniffer-plugin) - java compatibility checks\n* [pom-plugin](https://github.com/xvik/gradle-pom-plugin) - improves pom generation\n* [java-lib-plugin](https://github.com/xvik/gradle-java-lib-plugin) - avoid boilerplate for java or groovy library project\n* [github-info-plugin](https://github.com/xvik/gradle-github-info-plugin) - pre-configure common plugins with github related info\n* [yaml-updater](https://github.com/xvik/yaml-updater) - yaml configuration update tool, preserving comments and whitespaces\n\n\n---\n[![gradle plugin generator](http://img.shields.io/badge/Powered%20by-%20Gradle%20plugin%20generator-green.svg?style=flat-square)](https://github.com/xvik/generator-gradle-plugin)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxvik%2Fgradle-mkdocs-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxvik%2Fgradle-mkdocs-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxvik%2Fgradle-mkdocs-plugin/lists"}