{"id":21434070,"url":"https://github.com/bernardo-mg/docs-maven-skin","last_synced_at":"2025-07-14T14:31:16.235Z","repository":{"id":35917773,"uuid":"40205318","full_name":"Bernardo-MG/docs-maven-skin","owner":"Bernardo-MG","description":"Minimalist HTML5 and Bootstrap based Maven Skin for using Maven Site as a documentation site.","archived":false,"fork":false,"pushed_at":"2024-09-15T23:23:25.000Z","size":17444,"stargazers_count":36,"open_issues_count":16,"forks_count":9,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-09-16T07:01:52.741Z","etag":null,"topics":["bootstrap","html5","maven-plugin","maven-site","maven-skin","velocity"],"latest_commit_sha":null,"homepage":"","language":"CSS","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/Bernardo-MG.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2015-08-04T19:38:48.000Z","updated_at":"2024-09-15T00:13:56.000Z","dependencies_parsed_at":"2024-09-15T06:53:28.174Z","dependency_job_id":"4ed5453a-f52d-42a3-b14d-61291fc84502","html_url":"https://github.com/Bernardo-MG/docs-maven-skin","commit_stats":null,"previous_names":[],"tags_count":61,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bernardo-MG%2Fdocs-maven-skin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bernardo-MG%2Fdocs-maven-skin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bernardo-MG%2Fdocs-maven-skin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bernardo-MG%2Fdocs-maven-skin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bernardo-MG","download_url":"https://codeload.github.com/Bernardo-MG/docs-maven-skin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225980898,"owners_count":17554919,"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":["bootstrap","html5","maven-plugin","maven-site","maven-skin","velocity"],"created_at":"2024-11-22T23:33:08.348Z","updated_at":"2025-07-14T14:31:16.212Z","avatar_url":"https://github.com/Bernardo-MG.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docs Maven Skin\n\nA minimalist and responsive Bootstrap-based HTML5 skin for Maven Site, which will help to create documentation sites with Maven.\n\nIt is easy to use, just remember to check the included docs (generated with mvn verify site) to find out how to set it up, and also to find out how the skin looks in an actual Maven Site. New projects may as well make use of the [Library Maven Archetype][library-archetype] which, among other features, takes advantage of this skin and shows how to set it up.\n\nThe skin has been adapted from the static template [Docs Bootstrap Template][docs-template], which will be the visual reference to be followed by this project.\n\n## Maven Site version support\n\nDue to changes in the Maven Site plugin, the skin doesn't work with all versions of the plugin. Check the table to know which version of the skin is compatible.\n\n| Maven site version | Skin version  |\n|--------------------|---------------|\n| 3.20.x onwards     | 2.4.0 onwards |\n| 3.6.x up to 3.12.x | 2.3.x         |\n| Before 3.6.x       | 1.1.x         |\n\n[![Maven Central](https://img.shields.io/maven-central/v/com.bernardomg.maven.skins/docs-maven-skin.svg)][maven-repo]\n\n## Features\n\n- Minimalist and reactive look\n- HTML5\n- [Bootstrap 5][bootstrap]\n- [Font Awesome][font_awesome] icons\n- [highlight.js][highlight] for syntax highlighting\n- Prepared for [Facebook's Open Graph][open-graph] and [Twitter Cards][twitter-cards]\n\n## Demo\n\nThe project documentation makes use of the skin, it is always built with the latest release available. You can check the links just below this section.\n\n## Documentation\n\nDocumentation can  be generated with the following Maven command:\n\n```\nmvn verify site\n```\n\nThe verify phase is required, as otherwise some of the reports won't be created.\n\n## Acknowledgement\n\nThe project started as a fork of the [Reflow Maven Skin][reflow-skin], but it quickly became its own thing. Still, it owes much to that project.\n\n## Usage\n\nAs any Maven Skin it is handled through the Maven Plugin. Check the docs for more concrete information.\n\n### Prerequisites\n\nAs a Maven Skin, the project requirements are very specific:\n\n- Maven\n- Maven Site plugin (\u003e=3.21.0)\n- Maven Site enabled\n\n### Installing\n\nThe recommended way to install the project is by setting up your preferred dependencies manager. To get the configuration information for this check the [Maven Central Repository][maven-repo].\n\nIf for some reason manual installation is necessary, use the usual Maven installation command:\n\n```\nmvn install\n```\n\n### Reducing the Dependency Scope\n\nThere is no need to add the skin as a dependency for the full project. Just add it to the Maven site plugin:\n\n```xml\n\u003cbuild\u003e\n    \u003cplugins\u003e\n        ...\n        \u003cplugin\u003e\n            \u003cgroupId\u003eorg.apache.maven.plugins\u003c/groupId\u003e\n            \u003cartifactId\u003emaven-site-plugin\u003c/artifactId\u003e\n            \u003cdependencies\u003e\n                ...\n                \u003cdependency\u003e\n                    \u003c!-- Docs Maven Skin --\u003e\n                    \u003cgroupId\u003ecom.bernardomg.maven.skins\u003c/groupId\u003e\n                    \u003cartifactId\u003edocs-maven-skin\u003c/artifactId\u003e\n                    \u003cversion\u003e${site.skin.version}\u003c/version\u003e\n                \u003c/dependency\u003e\n                ...\n            \u003c/dependencies\u003e\n            ...\n        \u003c/plugin\u003e\n        ...\n    \u003c/plugins\u003e\n\u003c/build\u003e\n```\n\n### Setting Up the Skin\n\nRegister the skin into the site.xml file:\n\n```xml\n\u003cskin\u003e\n    \u003cgroupId\u003ecom.bernardomg.maven.skins\u003c/groupId\u003e\n    \u003cartifactId\u003edocs-maven-skin\u003c/artifactId\u003e\n    \u003cversion\u003e[current version]\u003c/version\u003e\n\u003c/skin\u003e\n```\n\nAfterwards the skin will be used when generating the site.\n\nMore detailed information can be found in the documentation. Including information for changing the theme.\n\n### Running Tests\n\nIntegration tests are included in the project to verify various configurations. These can be run by using the usual Maven command:\n\n```\nmvn verify\n```\n\nThey are run by using the [Maven Invoker Plugin][maven-invoker], and the configurations are included in the 'src/it' folder.\n\nPay attention that the results from generating these tests are copied to the generated Maven Site by the Maven Resources Plugin.\n\nIf using Eclipse the tests may not run, due to an incompatibility with the invoker. It is recommender running the tests through command line.\n\n## Collaborate\n\nAny kind of help with the project will be well received, and there are two main ways to give such help:\n\n- Reporting errors and asking for extensions through the issues management\n- or forking the repository and extending the project\n\n### Issues Management\n\nIssues are managed at the GitHub [project issues tracker][issues], where any GitHub user may report bugs or ask for new features.\n\n### Getting the Code\n\nIf you wish to fork or modify the code, visit the [GitHub project page][scm], where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.\n\n## License\n\nThe project has been released under the [MIT License][license].\n\n[reflow-skin]: https://github.com/andriusvelykis/reflow-maven-skin\n[maven-repo]: http://mvnrepository.com/artifact/com.bernardomg.maven.skins/docs-maven-skin\n[issues]: https://github.com/Bernardo-MG/docs-maven-skin/issues\n[license]: http://www.opensource.org/licenses/mit-license.php\n[scm]: https://github.com/Bernardo-MG/docs-maven-skin\n\n[maven-invoker]: http://maven.apache.org/plugins/maven-invoker-plugin/\n\n[library-archetype]: https://github.com/bernardo-mg/library-maven-archetype\n[docs-template]: https://github.com/Bernardo-MG/docs-bootstrap-template\n[bootstrap]: http://getbootstrap.com/\n[font_awesome]: https://fortawesome.github.io/Font-Awesome/\n[highlight]: https://highlightjs.org/\n[open-graph]: http://ogp.me/\n[twitter-cards]: https://dev.twitter.com/cards/overview\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbernardo-mg%2Fdocs-maven-skin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbernardo-mg%2Fdocs-maven-skin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbernardo-mg%2Fdocs-maven-skin/lists"}