https://github.com/quantummaid/documaid

DocuMaid is an easy to use plugin to reference code in your documentation and to validate that those links always exist. And you also can insert your current project's version anywhere.
https://github.com/quantummaid/documaid

Last synced: 1 day ago
JSON representation

DocuMaid is an easy to use plugin to reference code in your documentation and to validate that those links always exist. And you also can insert your current project's version anywhere.

• Host: GitHub
• URL: https://github.com/quantummaid/documaid
• Owner: quantummaid
• License: apache-2.0
• Created: 2019-12-28T09:26:28.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-06-14T22:44:34.000Z (almost 3 years ago)
• Last Synced: 2025-02-26T08:46:24.452Z (over 1 year ago)
• Language: Kotlin
• Homepage: https://quantummaid.de
• Size: 558 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Last Commit](https://img.shields.io/github/last-commit/quantummaid/documaid)](https://github.com/quantummaid/documaid)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/de.quantummaid/documaid/badge.svg)](https://maven-badges.herokuapp.com/maven-central/de.quantummaid/documaid)

[![Code Size](https://img.shields.io/github/languages/code-size/quantummaid/documaid)](https://github.com/quantummaid/documaid)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![Slack](https://img.shields.io/badge/chat%20on-Slack-brightgreen)](https://join.slack.com/t/quantummaid/shared_invite/zt-cx5qd605-vG10I~WazfgH9WOnXMzl3Q)

[![Gitter](https://img.shields.io/badge/chat%20on-Gitter-brightgreen)](https://gitter.im/quantum-maid-framework/community)

[![Twitter](https://img.shields.io/twitter/follow/quantummaid)](https://twitter.com/quantummaid)



# DocuMaid

DocuMaid keeps your documentation in sync with your codebase.

## Usage

To generate the documentation:

```

mvn de.quantummaid:documaid:0.9.35:generate

mvn de.quantummaid:documaid:0.9.35:generate -DskipPaths=docs/Usage.md

```

To validate whether the current documentation is correct and does not require any changes:

```

mvn de.quantummaid:documaid:0.9.35:validate

```

## Maven Configuration

```xml

    de.quantummaid

    documaid

    0.9.45

    

        

            

                generate

            

            verify

        

    

```

The full documentation can be found [here](documentation/Usage.md).