{"id":23838279,"url":"https://github.com/shred/mkdocs-maven-plugin","last_synced_at":"2025-09-07T15:32:27.162Z","repository":{"id":143560661,"uuid":"193334798","full_name":"shred/mkdocs-maven-plugin","owner":"shred","description":"A maven plugin for mkdocs","archived":true,"fork":false,"pushed_at":"2025-02-08T14:51:16.000Z","size":46,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-06T15:43:17.655Z","etag":null,"topics":["maven-plugin","mkdocs","moved-to-codeberg"],"latest_commit_sha":null,"homepage":"https://codeberg.org/shred/mkdocs-maven-plugin","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shred.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-GPL.txt","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":"2019-06-23T10:30:46.000Z","updated_at":"2025-02-08T14:52:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"a748ac14-c451-46d4-82f4-c4ddedb2b55f","html_url":"https://github.com/shred/mkdocs-maven-plugin","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/shred/mkdocs-maven-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shred%2Fmkdocs-maven-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shred%2Fmkdocs-maven-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shred%2Fmkdocs-maven-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shred%2Fmkdocs-maven-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shred","download_url":"https://codeload.github.com/shred/mkdocs-maven-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shred%2Fmkdocs-maven-plugin/sbom","scorecard":{"id":821006,"data":{"date":"2025-08-11","repo":{"name":"github.com/shred/mkdocs-maven-plugin","commit":"3e8f259229ab7d67d59ae0b7d47e03b7a18808fa"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":1,"reason":"Found 2/15 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE-GPL.txt:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE-GPL.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.2 not signed: https://api.github.com/repos/shred/mkdocs-maven-plugin/releases/169140194","Warn: release artifact v1.1 not signed: https://api.github.com/repos/shred/mkdocs-maven-plugin/releases/113117756","Warn: release artifact v1.0 not signed: https://api.github.com/repos/shred/mkdocs-maven-plugin/releases/18165482","Warn: release artifact v1.2 does not have provenance: https://api.github.com/repos/shred/mkdocs-maven-plugin/releases/169140194","Warn: release artifact v1.1 does not have provenance: https://api.github.com/repos/shred/mkdocs-maven-plugin/releases/113117756","Warn: release artifact v1.0 does not have provenance: https://api.github.com/repos/shred/mkdocs-maven-plugin/releases/18165482"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 7 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":7,"reason":"3 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-5mg8-w23w-74h3","Warn: Project is vulnerable to: GHSA-7g45-4rm6-3mm3","Warn: Project is vulnerable to: GHSA-j288-q9x7-2f5v"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T15:35:36.070Z","repository_id":143560661,"created_at":"2025-08-23T15:35:36.070Z","updated_at":"2025-08-23T15:35:36.070Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274057797,"owners_count":25215194,"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","status":"online","status_checked_at":"2025-09-07T02:00:09.463Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["maven-plugin","mkdocs","moved-to-codeberg"],"created_at":"2025-01-02T16:53:46.783Z","updated_at":"2025-09-07T15:32:27.122Z","avatar_url":"https://github.com/shred.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# mkdocs-maven-plugin ![build status](https://shredzone.org/badge/mkdocs-maven-plugin.svg) ![maven central](https://shredzone.org/maven-central/org.shredzone.maven/mkdocs-maven-plugin/badge.svg)\n\nThis is a maven plugin that invokes [mkdocs](https://www.mkdocs.org/).\n\nA recent version of `mkdocs` must be [installed](https://www.mkdocs.org/#installation) on your machine.\n\n## Goals\n\nThis plugin offers three goals. All of them have these configuration options in common:\n\n* `skip` (Property: `mkdocs.skip`): Skips mkdocs execution if set to `true`. Might be useful in some situations. Mkdocs is always skipped if no `mkdocs.yml` file can be found. This is useful if you use sub-modules, but only have documentation in the main module.\n\n* `directory` (Property: `mkdocs.docs`): Directory of your documentation. By default, the `mkdocs.yml` and the mkdocs directory structure is expected here. Defaults to `${basedir}/src/doc`.\n\n* `configFile` (Property: `mkdocs.mkfile`): The location of your `mkdocs.yml` file. By default it is expected in your `directory`.\n\n* `mkdocsPath` (Property: `mkdocs.toolPath`): The location of the `mkdocs` tool that is to be executed. By default, it uses the first `mkdocs` command in your system path.\n\n* `mkdocsCommand` (Property: `mkdocs.toolCommand`): Used as an alternative to `mkdocsPath`, it contains a list of `\u003carg\u003e` options for the full `mkdocs` command and extra parameters. This can be used e.g. if mkdocs is to be run directly in Python. If set, `mkdocsPath` is ignored. \n\n* `environmentVars` (Property: `mkdocs.environment`): An optional map of environment variables to be set before running mkdocs.\n\nAll configuration parameters are optional.\n\n### `mkdocs:build`\n\nThis goal builds from `src/doc` into `target/mkdocs`. You can change the behavior with the following configuration options:\n\n* `theme` (Property: `mkdocs.theme`): The name of the theme to be used.\n\n* `themeDirectory` (Property: `mkdocs.themeDirectory`): The path to a theme directory.\n\n* `strict` (Property: `mkdocs.strict`): If set to `true`, mkdocs will abort the build on any warning. Defaults to `false`.\n\n* `outputDirectory` (Property: `mkdocs.outputDirectory`): The target directory of your documentation. Defaults to `${project.build.directory}/mkdocs`.\n\n* `clean` (Property: `mkdocs.clean`): If set to `true`, old files will be removed from the target directory before building. Defaults to `true`.\n\n### `mkdocs:serve`\n\nThis goal serves your documentation on a local server, so you can view it on a browser while editing it. You can invoke `mvn mkdocs:serve` to start serving, and end it by pressing Ctrl-C.\n\n* `host` (Property: `mkdocs.serve.host`): The host the server is listening at. Defaults to `localhost` or `127.0.0.1`.\n\n* `port` (Property: `mkdocs.serve.port`): The port the server is listening on. Defaults to `8000`.\n\n* `liveReload` (Property: `mkdocs.serve.liveReload`): If set to `true`, live reload mode is enabled. Defaults to `true`.\n\n* `theme` (Property: `mkdocs.theme`): The name of the theme to be used.\n\n* `themeDirectory` (Property: `mkdocs.themeDirectory`): The path to a theme directory.\n\n* `strict` (Property: `mkdocs.strict`): If set to `true`, mkdocs will abort the build on any warning. Defaults to `false`.\n\n### `mkdocs:gh-deploy`\n\nThis goal deploys your documentation to GitHub pages.\n\n* `clean` (Property: `mkdocs.clean`): If set to `true`, old files will be removed from the target directory before building. Defaults to `true`.\n\n* `message` (Property: `mkdocs.deploy.message`): Commit message.\n\n* `remoteBranch` (Property: `mkdocs.deploy.remoteBranch`): The remote branch to commit to.\n\n* `remoteName` (Property: `mkdocs.deploy.remoteName`): The remote name to commit to.\n\n* `force` (Property: `mkdocs.deploy.force`): If set to `true`, push is forced.\n\n## Dependency\n\nJust add these lines to your `pom.xml` and insert the correct version number.\n\n```xml\n\u003cbuild\u003e\n  \u003cplugins\u003e\n    \u003cplugin\u003e\n      \u003cgroupId\u003eorg.shredzone.maven\u003c/groupId\u003e\n      \u003cartifactId\u003emkdocs-maven-plugin\u003c/artifactId\u003e\n      \u003cversion\u003e..\u003c/version\u003e\n    \u003c/plugin\u003e\n  \u003c/plugins\u003e\n\u003c/build\u003e\n```\n\n## Contribute\n\n* Fork the [Source code at Codeberg](https://codeberg.org/shred/mkdocs-maven-plugin). Feel free to send pull requests.\n* Found a bug? [File a bug report!](https://codeberg.org/shred/mkdocs-maven-plugin/issues)\n\n## License\n\n_mkdocs-maven-plugin_ is open source software. The source code is distributed under the terms of [GNU General Public License Version 3](http://www.gnu.org/licenses/gpl-3.0.html).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshred%2Fmkdocs-maven-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshred%2Fmkdocs-maven-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshred%2Fmkdocs-maven-plugin/lists"}