https://github.com/fugerit-org/yaml-doc-maven-plugin

Simple maven plugin for the yaml-doc-tool project
https://github.com/fugerit-org/yaml-doc-maven-plugin

documentation freemarker java maven-plugin openapi openapi3 snake-yaml yaml

Last synced: about 1 year ago
JSON representation

Simple maven plugin for the yaml-doc-tool project

• Host: GitHub
• URL: https://github.com/fugerit-org/yaml-doc-maven-plugin
• Owner: fugerit-org
• License: apache-2.0
• Created: 2022-03-23T15:26:14.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-02T13:49:38.000Z (about 2 years ago)
• Last Synced: 2024-06-02T15:10:40.844Z (about 2 years ago)
• Topics: documentation, freemarker, java, maven-plugin, openapi, openapi3, snake-yaml, yaml
• Language: Java
• Homepage: https://www.fugerit.org/
• Size: 64.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# yaml-doc-maven-plugin

Simple maven plugin for [yaml-doc-tool](https://github.com/fugerit-org/yaml-doc-tool) project.

[![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](CHANGELOG.md) 

[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/yaml-doc-maven-plugin.svg)](https://mvnrepository.com/artifact/org.fugerit.java/yaml-doc-maven-plugin)

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

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_yaml-doc-maven-plugin&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_yaml-doc-maven-plugin)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_yaml-doc-maven-plugin&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_yaml-doc-maven-plugin)

Accepted config params are :  

* configPath

* idCatalog

Here a sample configuration  :

```

			

				org.fugerit.java

				yaml-doc-maven-plugin

				${yaml-doc-version}	

				

					src/config/yaml-doc-config.xml

					openapi		

											

				

					

						openapi

						

							generate

						

							

				

				

```