{"id":36619309,"url":"https://github.com/luiinge/docsite-maven-plugin","last_synced_at":"2026-01-12T09:17:39.664Z","repository":{"id":42957329,"uuid":"395047343","full_name":"luiinge/docsite-maven-plugin","owner":"luiinge","description":"A Maven plugin that generates automatic documentation sites","archived":false,"fork":false,"pushed_at":"2023-06-14T22:50:32.000Z","size":3220,"stargazers_count":3,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-19T04:54:40.771Z","etag":null,"topics":["generator","java","maven","maven-plugin","site","website"],"latest_commit_sha":null,"homepage":"https://luiinge.github.io/docsite-maven-plugin/","language":"HTML","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/luiinge.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}},"created_at":"2021-08-11T16:09:38.000Z","updated_at":"2023-01-09T08:23:50.000Z","dependencies_parsed_at":"2023-01-20T02:17:41.351Z","dependency_job_id":null,"html_url":"https://github.com/luiinge/docsite-maven-plugin","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/luiinge/docsite-maven-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luiinge%2Fdocsite-maven-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luiinge%2Fdocsite-maven-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luiinge%2Fdocsite-maven-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luiinge%2Fdocsite-maven-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luiinge","download_url":"https://codeload.github.com/luiinge/docsite-maven-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luiinge%2Fdocsite-maven-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28337675,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T06:09:07.588Z","status":"ssl_error","status_checked_at":"2026-01-12T06:05:18.301Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["generator","java","maven","maven-plugin","site","website"],"created_at":"2026-01-12T09:17:39.297Z","updated_at":"2026-01-12T09:17:39.658Z","avatar_url":"https://github.com/luiinge.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"Docsite Maven Plugin\n================================================================================\n\n![GitHub](https://img.shields.io/github/license/luiinge/docsite-maven-plugin?style=plastic)\n![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/luiinge/docsite-maven-plugin/quality%20check/master?style=plastic)\n![Maven Central](https://img.shields.io/maven-central/v/io.github.luiinge/docsite-maven-plugin?style=plastic)\n\n\nDocsite is a Maven plugin that generates static documentation sites\nwith minimal effort. It is an alternative to the standard Maven site generation, \nproviding the following benefits:\n- No extra configuration files required\n- Several source formats including Markdown, Asciidoc, HTML, XML, JSON and YAML\n- Automatic generation of ToCs (*Table of Content*)\n- Code syntax highlighting using [Prism](https://prismjs.com)\n- Diagram rendering using [Mermaid](https://mermaid-js.github.io/)\n- Not bound to any Maven reporting plugin\n- Easily customizable\n- Responsiveness\n- Usage of HTML5 semantic tags (aimed to get good SEO positioning)\n\n\u003e This very site has been generated using Docsite (check [the site](https://luiinge.github.io/docsite-maven-plugin/) \nin case you are reading this document from Github).\n\nGet started\n-----------------------------------------------------------------------------------------\n\n1. Add the plugin to your `build` configuration in the `pom.xml` file:\n```xml\n    \u003cbuild\u003e\n        \u003cplugins\u003e\n            \u003cplugin\u003e\n                \u003cgroupId\u003eio.github.luiinge\u003c/groupId\u003e\n                \u003cartifactId\u003edocsite-maven-plugin\u003c/artifactId\u003e\n                \u003cversion\u003e1.5.2\u003c/version\u003e\n            \u003c/plugin\u003e\n        \u003c/plugins\u003e\n    \u003c/build\u003e\n```\n2. Create the origin resources if necessary (such as Javadocs or some Maven reports)\n3. Run the `docsite:generate` goal\n```shell\nmvn docsite:generate\n```\n\n\nIf you want a custom site structure, you can pass an external JSON file with the docsite \ndefinition:\n```shell\nmvn docsite:generate -Ddocsite.docsiteFile=mydocsite.json\n```\n\nYou can also provide custom configuration just after the declaration of \nthe plugin within the `pom`. \n```xml\n    \u003cbuild\u003e\n        \u003cplugins\u003e\n            \u003cplugin\u003e\n                \u003cgroupId\u003eio.github.luiinge\u003c/groupId\u003e\n                \u003cartifactId\u003edocsite-maven-plugin\u003c/artifactId\u003e\n                \u003cversion\u003e1.5.2\u003c/version\u003e\n                \u003cconfiguration\u003e\n                    \u003cdocsite\u003e\n                        ...\n                        \u003csections\u003e\n                            \u003csection\u003e\n                                ...\n                            \u003c/section\u003e\n                        \u003c/sections\u003e\n                    \u003c/docsite\u003e\n                \u003c/configuration\u003e\n            \u003c/plugin\u003e\n        \u003c/plugins\u003e\n    \u003c/build\u003e\n```\n\n\nCheck the [goal documentation](plugin-goals.html) for an exhaustive \nlist of every configuration parameter.\n\n\n### Documentation sections\nApart from the landing page, you can define different sections for the \ndocumentation site. Each section would generate its own page and also \nan entry in the navigation menu at the header.\nEach section must define the type of strategy that would be used in order \nto generate the proper output. The available section types are:\n\n#### Generated page\nA single HTML page would be generated from a source file. Markdown,\nHTML and raw text sources are processed directly, whereas XML, JSON and YAML sources\nrequires a [Freemarker](https://freemarker.apache.org/) transformation template.\n```xml\n\u003csection\u003e\n    \u003ctype\u003egenerated\u003c/type\u003e\n    \u003cname\u003eChangelog\u003c/name\u003e\n    \u003csource\u003eCHANGELOG.md\u003c/source\u003e\n\u003c/section\u003e\n```\n```xml\n\u003csection\u003e\n    \u003ctype\u003egenerated\u003c/type\u003e\n    \u003cname\u003eDependencies\u003c/name\u003e\n    \u003csource\u003etarget/dependencies.xml\u003c/source\u003e\n    \u003ctemplate\u003etemplates/dependencies.ftl\u003c/template\u003e\n\u003c/section\u003e\n```\n#### Embedded site\nA complete site (from a local folder) would be copied into the \ndocumentation site, and shown inside an embedded `iframe` component. \n```xml\n\u003csection\u003e\n    \u003ctype\u003eembedded\u003c/type\u003e\n    \u003cname\u003eJavadoc\u003c/name\u003e\n    \u003csource\u003etarget/site/apidocs\u003c/source\u003e\n    \u003csiteIndex\u003eindex.html\u003c/siteIndex\u003e\n\u003c/section\u003e\n```\n\n#### Copy site\nA complete site (from a local folder) would be copied into the\ndocumentation site, but linked and loaded in a new tab as an independent page.\n```xml\n\u003csection\u003e\n    \u003ctype\u003ecopy\u003c/type\u003e\n    \u003cname\u003eJavadoc\u003c/name\u003e\n    \u003csource\u003etarget/site/apidocs\u003c/source\u003e\n    \u003csiteIndex\u003eindex.html\u003c/siteIndex\u003e\n\u003c/section\u003e\n```\n\n#### Section Group\nA simple HTML page would be generated including links to other sections\nof the documentation site. These linked sections are defined hierarchically in \nthe `subsections` property of the section. Also, a dropdown menu would be used\nin the navigation header.\n```xml\n\u003csection\u003e\n    \u003ctype\u003egroup\u003c/type\u003e\n    \u003cname\u003eReports\u003c/name\u003e\n    \u003csubsections\u003e\n        \u003csection\u003e\n            ...\n        \u003c/section\u003e\n        \u003csection\u003e\n            ...\n        \u003c/section\u003e\n    \u003c/subsections\u003e\n\u003c/section\u003e\n```\n \n#### Link\nNo specific page is generated, but rather a simple link in the navigation\nheader.\n```xml\n\u003csection\u003e\n    \u003ctype\u003elink\u003c/type\u003e\n    \u003cname\u003eCompany Site\u003c/name\u003e\n    \u003csource\u003ehttp://my.company.com\u003c/source\u003e\n\u003c/section\u003e\n```\n\n\n\n\n\n### Auto-configured sites\nIn absence of a site configuration, the plugin would generate one for you.\nAlthough not fully compliant with every posible scenario, it would make an attempt \nto generate a good-enough site according the resources found in the project:\n\n- The project name and description set in the `pom.xml` file would be used as the title in \nthe site header\n- In presence of a main `README.*` file, it would be used as the landing \npage of the site.\n- In presence of a `CHANGELOG.*` file, a *Changelog* section would be created\n- In presence of a `LICENSE` file, a *License* section would be created\n- In presence of the `target/site/apidocs` directory, a subsection *Javadoc* would be \ncreated within the main report section\n- In presence of the `target/site/dependencies.html` file, a subsection *Dependencies* would be\n  created within the main report section\n- In presence of the `target/site/surefire-report.html` file, a subsection *Test Results* would be\n  created within the main report section\n- In presence of the `target/site/jacoco` directory, a subsection *Coverage* would be\n  created within the main report section\n- In presence of the `target/classes/META-INF/maven/plugin.xml` (specific for Maven plugin\n  projects), a subsection *Plugin Goals* would be created within the main report section.\n- If the `scm` section of the `pom.xml` file is filled, a link to the corresponding version control \nsite would be added (with custom icons for Github, Gitlab and Bitbucket)\n\nThe following configuration would be equivalent to the autogenerated configuration:\n\n```xml\n\u003cdocsite\u003e\n    \u003ctitle\u003e${project.name}\u003c/title\u003e\n    \u003cdescription\u003e${project.description}\u003c/description\u003e\n    \u003cindex\u003eREADME.md\u003c/index\u003e\n    \u003csections\u003e\n        \u003csection\u003e\n            \u003ctype\u003egenerated\u003c/type\u003e\n            \u003cname\u003eChangelog\u003c/name\u003e\n            \u003cdescription\u003eLog of modifications on new versions\u003c/description\u003e\n            \u003csource\u003eCHANGELOG.md\u003c/source\u003e\n            \u003cicon\u003efas:clipboard-list\u003c/icon\u003e\n        \u003c/section\u003e\n        \u003csection\u003e\n            \u003ctype\u003egroup\u003c/type\u003e\n            \u003cname\u003eReports\u003c/name\u003e\n            \u003cdescription\u003eCollection of technical reports about this project\u003c/description\u003e\n            \u003cicon\u003efas:file-medical-alt\u003c/icon\u003e\n            \u003csubsections\u003e\n                \u003csection\u003e\n                    \u003ctype\u003eembedded\u003c/type\u003e\n                    \u003cname\u003eJavadoc\u003c/name\u003e\n                    \u003csource\u003e${project.reporting.outputDirectory}/apidocs\u003c/source\u003e\n                    \u003cicon\u003efab:java\u003c/icon\u003e\n                \u003c/section\u003e\n                \u003csection\u003e\n                    \u003ctype\u003egenerated\u003c/type\u003e\n                    \u003cname\u003ePlugin Goals\u003c/name\u003e\n                    \u003csource\u003e${project.build.outputDirectory}/classes/META-INF/maven/plugin.xml\u003c/source\u003e\n                    \u003ctemplate\u003emaven-plugin-descriptor\u003c/template\u003e\n                \u003c/section\u003e\n                \u003csection\u003e\n                    \u003ctype\u003egenerated\u003c/type\u003e\n                    \u003cname\u003eTest Results\u003c/name\u003e\n                    \u003csource\u003e${project.reporting.outputDirectory}/surefire-report.html\u003c/source\u003e\n                \u003c/section\u003e\n                \u003csection\u003e\n                    \u003ctype\u003eembedded\u003c/type\u003e\n                    \u003cname\u003eTest Coverage\u003c/name\u003e\n                    \u003csource\u003e${project.reporting.outputDirectory}/jacoco\u003c/source\u003e\n                \u003c/section\u003e\n                \u003csection\u003e\n                    \u003ctype\u003egenerated\u003c/type\u003e\n                    \u003cname\u003eDependencies\u003c/name\u003e\n                    \u003csource\u003e${project.reporting.outputDirectory}/dependencies.html\u003c/source\u003e\n                    \u003creplaceEmojis\u003efalse\u003c/replaceEmojis\u003e\n                \u003c/section\u003e\n            \u003c/subsections\u003e\n        \u003c/section\u003e\n        \u003csection\u003e\n            \u003ctype\u003elink\u003c/type\u003e\n            \u003cname\u003eSource\u003c/name\u003e\n            \u003csource\u003ehttps://github.com/luiinge/docsite-maven-plugin\u003c/source\u003e\n            \u003cicon\u003efab:github\u003c/icon\u003e\n        \u003c/section\u003e\n        \u003csection\u003e\n            \u003ctype\u003egenerated\u003c/type\u003e\n            \u003cname\u003eLicense\u003c/name\u003e\n            \u003csource\u003eLICENSE\u003c/source\u003e\n            \u003cicon\u003efas:balance-scale\u003c/icon\u003e\n        \u003c/section\u003e\n    \u003c/sections\u003e\n\u003c/docsite\u003e\n```\n\n### Multi-module projects\nIn case you are working with a multi-module Maven project, you would require to execute\ntwo different goals.\n- Firstly, the `generate` goal that would generate a site per sub-project\n- Secondly, the `aggregate` goal that would generate a different site only for the root \nproject.\nYou can pass a different docsite configuration to the `aggregate` goal with `embedded` or\n`copy` sections referring to the subproject sites.\n\nFor example, your root `pom.xml` might contain something like the following:\n```xml\n    \u003cbuild\u003e\n        \u003cplugins\u003e\n            \u003cplugin\u003e\n                \u003cgroupId\u003eio.github.luiinge\u003c/groupId\u003e\n                \u003cartifactId\u003edocsite-maven-plugin\u003c/artifactId\u003e\n                \u003cversion\u003e1.2.1\u003c/version\u003e\n                \u003cexecutions\u003e\n                  \u003cexecution\u003e\n                    \u003cgoals\u003e\n                      \u003cgoal\u003egenerate\u003c/goal\u003e\n                    \u003c/goals\u003e\n                    \u003cconfiguration\u003e\n                        \u003cdocsite\u003e\n                          \u003c!-- common configuration applied to each subproject --\u003e\n                        \u003c/docsite\u003e\n                    \u003c/configuration\u003e\n                  \u003c/execution\u003e\n                  \u003cexecution\u003e\n                    \u003cgoals\u003e\n                      \u003cgoal\u003eaggregate\u003c/goal\u003e\n                    \u003c/goals\u003e\n                    \u003cconfiguration\u003e\n                      \u003cdocsite\u003e\n                        \u003c!-- configuration applied to root subproject --\u003e\n                      \u003c/docsite\u003e\n                    \u003c/configuration\u003e\n                  \u003c/execution\u003e\n                \u003c/executions\u003e\n            \u003c/plugin\u003e\n        \u003c/plugins\u003e\n    \u003c/build\u003e\n```\n\n\nAdvanced usage\n-----------------------------------------------------------------------------------------\n\n### Icons\nFor the main property `logo`, as well as the section property `icon`, you can choose among\ndifferent sources according the property value:\n- Starting with `http:` or `https:`, the image source would be an external link to the given URL\n- Starting with `fa:`, `fas:`, `far:` or `fab:`, the image would be a\n  [Font Awesome 5](http://https://fontawesome.com/v5.15/icons) icon\n- Starting with `data:image`, you can embed an image using the corresponding Base64 code\n(as defined in [RFC-2397](https://datatracker.ietf.org/doc/html/rfc2397))\n- Otherwise, a local image file would be expected\n\n\n### Github emojis\n[Github](https://github.com) uses a mechanism that replaces specific text markups with icons when \ndisplaying certain documents (for example, the following would be rendered as an emoji: :smile:). \nThe pages generated with Docsite would apply the same transformations by \ndefault in order to emulate such representation. However, it is possible that some documents \nuse those markups without any emoji intention and hence the generated page would contain \nunexpected images. If you experience this problem, simply disable the emoji replacement by setting \nto `false` the property `replaceEmojis` in the problematic section.\n\n\n### About CDN resources\nThe websites generated with Docsite make use of CDN (Content Distribution Network) for \nsome required resources ([Font Awesome 5](http://https://fontawesome.com/v5.15/icon)\nand [Prism](https://prismjs.com/) scripts and stylesheets). This is highly advisable \nto improve loading time and reducing traffic. However, there might be specific scenarios \nwhere a local copy would be preferred. \nYou can instruct Docsite to use a local copy of such resources setting to `false` the property \n`useCDN`.\n\n\n### Maven lifecycle\nIn contrast with the default Maven site generation, that is based in the concept of pluggable\nreports, Docsite *does not* require to be executed in the context of a Maven site. The `generate`\ngoal is attached to the `post-site` phase by default, but you are not forced to invoke the `site`\ngoal at all. Rather, you can redefine the phase or invoke `docsite:generate` at will.\nThe only consideration is that in most cases you may require the result of some other report that \nis intended to be used with `site`. Some report plugins have goals that can be executed \nstandalone, but most require the `site` context.\n\n\n### Using Docsite without Maven\nThis piece of software is designed as a Maven plugin, but actually that is a loose requirement. \nAs any regular Jar file, you can include it (along with its dependencies) in your classpath and \nmake use of the `DocsiteEmitter` class without a Maven executor. It is, though, still advisable\nthat you peek the implementation of `DocsiteMojo` in order to get the idea of the minimum setup\nrequired.\n\n\n### Adding analytic features\nIf you want to analyze the traffic of your documentation site, you may need to insert custom \ncode into the `head` section, such as specific meta-data or binding scripts. In order to allow \nthat, any custom code can be added using the `metadata` and `scripts` properties. \nHere you can add your extra code, like in the following example:\n```xml\n\u003cconfiguration\u003e\n      ...\n      \u003cmetadata\u003e\n        \u003ckeywords\u003eCSS,Javascript\u003c/keywords\u003e\n      \u003c/metadata\u003e\n     ...\n      \u003cscripts\u003e\n        \u003cscript\u003e\n          \u003csrc\u003ehttps://www.googletagmanager.com/gtag/js?id=XXXXXXX\u003c/src\u003e\n          \u003casync\u003etrue\u003c/async\u003e\n        \u003c/script\u003e\n        \u003cscript\u003e\n          \u003ccode\u003e\n            window.dataLayer = window.dataLayer || [];\n            function gtag(){ dataLayer.push(arguments); }\n            gtag('js', new Date());\n            gtag('config', 'XXXXXXXXX');\n          \u003c/code\u003e\n        \u003c/script\u003e\n      \u003c/scripts\u003e\n      ...\n\u003c/configuration\u003e\n```\n\nLocalization\n-------------------------------------------------------------------------------------\nYou can enrich your documentation site providing localized versions of some documents.\nWhen enabled, a language selection option would be accessible in every page in the \ntop right corner.\n\nIn order to enable the localization features, you must provide the list of provided \nlanguages within the plugin configuration. For example:\n\n```xml\n\u003cconfiguration\u003e\n      ...\n      \u003clanguages\u003e\n        \u003clanguage\u003een:English\u003c/language\u003e\n        \u003clanguage\u003ees:Español\u003c/language\u003e\n      \u003c/languages\u003e\n      ...\n\u003c/configuration\u003e\n```\n\nEach language is defined by two codes separated by `:`. The first code is the *language code* \nused by your localized documents. The second code corresponds to the *display language* and \nshould be the translated name of the language. Notice that the first language in the list is \nconsidered as the *primary language*.\n\n\nDuring the generation process, for each section marked with the `generated` type, \na similar source file will be searched at the same location of the original source, \nbut with a prefix indicating the *language code* just before the extension (or just at the \nend of the name if there is no extension). For example, for a given `README.md` file and the \nadditional language code `es`, a file named `README_es.md` would be expected.\nThe *primary language*, however, would use the file with the regular name, \njust like if no localization was defined.\n\n\nIn addition to the document content, you can provide translations for the names and descriptions\nused by the site and its sections. In order to do that, use the `localizations` configuration\nproperty. For example:\n\n```xml\n\u003cconfiguration\u003e\n      ...\n      \u003cdocsite\u003e\n        \u003ctitle\u003eMy Project Title\u003c/title\u003e\n        \u003cdescription\u003eMy Project Description\u003c/description\u003e\n        \u003cindex\u003eREADME.md\u003c/index\u003e\n        \u003csections\u003e\n            \u003csection\u003e\n                \u003ctype\u003egenerated\u003c/type\u003e\n                \u003cname\u003eChangelog\u003c/name\u003e\n                \u003cdescription\u003eLog of modifications\u003c/description\u003e\n                \u003csource\u003eCHANGELOG.md\u003c/source\u003e\n            \u003c/section\u003e\n        \u003c/sections\u003e\n      \u003c/docsite\u003e\n\n      \u003clanguages\u003e\n        \u003clanguage\u003een:English\u003c/language\u003e\n        \u003clanguage\u003ees:Español\u003c/language\u003e\n      \u003c/languages\u003e\n\n      \u003clocalizations\u003e\n        \u003clocalization\u003e\n          \u003clanguage\u003ees\u003c/language\u003e\n          \u003cvalues\u003e\n            \u003cChangelog\u003eHistorial de cambios\u003c/Changelog\u003e\n          \u003c/values\u003e\n        \u003c/localization\u003e\n      \u003c/localizations\u003e\n\n\u003c/configuration\u003e\n```\n\nAlternatively, you can create a JSON file like the following:\n```json\n{\n  \"es\": {\n    \"My Project Title\": \"Título del proyecto\",\n    \"My Project Description\": \"Descripción de mi proyecto\",\n    \"Changelog\": \"Historial de cambios\"\n  }\n}\n```\n\nand pass it with the property `localizationFile`.\n\n\nNotice that the *primary language* has no translations in the JSON file, since \nthey are directly provided in the configuration and are used as keys for the other \nlanguages.\n\n\n\nCommon Issues\n----------------------------------------------------------------------------------------\n\n### `No plugin found for prefix 'docsite' in the current project and in the plugin`. \n\nYou can get this message when running `mvn docsite:generate` or `mvn docsite:aggregate`. \nThat is because Maven only resolve plugin prefixes for plugins belonging to the groups \n`org.apache.maven.plugins` and `org.codehaus.mojo`. There are several ways to solve this issue:\n\n- **Option A.** Edit your Maven settings file (per-user: `${user.home}/.m2/settings.xml`; \nglobal: `${maven.home}/conf/settings.xml`), adding the following:\n\n  ```xml\n  \u003csettings\u003e\n     ...\n     \u003cpluginGroups\u003e\n       \u003cpluginGroup\u003eio.github.luiinge\u003c/pluginGroup\u003e\n     \u003c/pluginGroups\u003e\n  \u003c/settings\u003e\n  ```\n\n  \u003e In case you are using this tool during a CI/CD operation, you will require to edit the \n  \u003e `settings.xml` file during the operation. Check the documentation of your CI/CD platform\n  \u003e to find out how to accomplish this.\n\n- **Option B.** Use the full name of the plugin: \n\n  ```shell\n  mvn io.github.luiinge:docsite-maven-plugin:1.5.2:generate\n  ```\n  \n  Be aware that by using this method you *cannot* define the configuration in the `pom`, \n  you must pass any configuration data via parameters\n\n- **Option C.** Bound the execution to one of the build phases and run the predefined\n  goal. For example, using the following:\n\n  ```xml\n  \u003cplugin\u003e\n    \u003cgroupId\u003eio.github.luiinge\u003c/groupId\u003e\n    \u003cartifactId\u003edocsite-maven-plugin\u003c/artifactId\u003e\n    \u003cversion\u003e1.5.2\u003c/version\u003e\n    \u003cconfiguration\u003e ... \u003c/configuration\u003e\n    \u003cexecutions\u003e\n      \u003cexecution\u003e\n        \u003cid\u003egenerate-site\u003c/id\u003e\n        \u003cgoals\u003e\n          \u003cgoal\u003egenerate\u003c/goal\u003e\n        \u003c/goals\u003e\n        \u003cphase\u003eprepare-package\u003c/phase\u003e\n      \u003c/execution\u003e\n    \u003c/executions\u003e\n  \u003c/plugin\u003e\n  ```\n  \n  and running \n\n  ```shell\n  mvn package\n  ```\n\n\n\nMetrics\n-----------------------------------------------------------------------------------------\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=luiinge_docsite-maven-plugin\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=luiinge_docsite-maven-plugin)\n\n\n[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=luiinge_docsite-maven-plugin\u0026metric=ncloc)](https://sonarcloud.io/dashboard?id=luiinge_docsite-maven-plugin)\n\n\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=luiinge_docsite-maven-plugin\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=luiinge_docsite-maven-plugin)\n\n\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=luiinge_docsite-maven-plugin\u0026metric=bugs)](https://sonarcloud.io/dashboard?id=luiinge_docsite-maven-plugin)\n\n\n[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=luiinge_docsite-maven-plugin\u0026metric=code_smells)](https://sonarcloud.io/dashboard?id=luiinge_docsite-maven-plugin)\n\n\n[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=luiinge_docsite-maven-plugin\u0026metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=luiinge_docsite-maven-plugin)\n\n\n[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=luiinge_docsite-maven-plugin\u0026metric=sqale_index)](https://sonarcloud.io/dashboard?id=luiinge_maven-docsite-maven-plugin)\n\n\nAuthors\n-----------------------------------------------------------------------------------------\n\n- Luis Iñesta Gelabert  |  luiinge@gmail.com\n\n\nContributions\n-----------------------------------------------------------------------------------------\nIf you want to contribute to this project, visit the\n[Github project](https://github.com/luiinge/docsite-maven-plugin). You can open a new issue / feature\nrequest, or make a pull request to consider. If your contribution is worthy, you will be added\nas a contributor in this very page.\n\nIssue reporting\n-----------------------------------------------------------------------------------------\nIf you have found any defect in this software, please report it\nin [Github project Issues](https://github.com/luiinge/docsite-maven-plugin/issues).\nThere is no guarantee that it would be fixed in the following version, but it would\nbe addressed as soon as possible.   \n ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluiinge%2Fdocsite-maven-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluiinge%2Fdocsite-maven-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluiinge%2Fdocsite-maven-plugin/lists"}