{"id":13398306,"url":"https://github.com/mkdocs/mkdocs","last_synced_at":"2025-12-16T14:03:13.903Z","repository":{"id":13148178,"uuid":"15830664","full_name":"mkdocs/mkdocs","owner":"mkdocs","description":"Project documentation with Markdown.","archived":false,"fork":false,"pushed_at":"2025-10-20T13:17:06.000Z","size":33238,"stargazers_count":21188,"open_issues_count":128,"forks_count":2550,"subscribers_count":226,"default_branch":"master","last_synced_at":"2025-10-23T17:58:06.818Z","etag":null,"topics":["documentation","markdown","mkdocs","python","static-site-generator"],"latest_commit_sha":null,"homepage":"https://www.mkdocs.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mkdocs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":"FUNDING.yml","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},"funding":{"github":"mkdocs"}},"created_at":"2014-01-11T21:05:21.000Z","updated_at":"2025-10-23T12:22:49.000Z","dependencies_parsed_at":"2024-01-03T04:47:56.825Z","dependency_job_id":"3aa8c6cb-6f76-4239-8594-70f2f4ccbbad","html_url":"https://github.com/mkdocs/mkdocs","commit_stats":{"total_commits":1701,"total_committers":270,"mean_commits":6.3,"dds":0.7730746619635509,"last_synced_commit":"7e4892ab2dd4a52efd95a9de407eee63310e0780"},"previous_names":[],"tags_count":61,"template":false,"template_full_name":null,"purl":"pkg:github/mkdocs/mkdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fmkdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fmkdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fmkdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fmkdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mkdocs","download_url":"https://codeload.github.com/mkdocs/mkdocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mkdocs%2Fmkdocs/sbom","scorecard":{"id":652308,"data":{"date":"2025-08-11","repo":{"name":"github.com/mkdocs/mkdocs","commit":"f68e5fc18d3cd3811dbddfdeda1a57721f9e2e4e"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5,"checks":[{"name":"Code-Review","score":9,"reason":"Found 16/17 approved changesets -- score normalized to 9","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":"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":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"Maintained","score":5,"reason":"1 commit(s) and 5 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 2-Clause \"Simplified\" License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/deploy-release.yml:7"],"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":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/autofix.yml:1","Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Warn: no topLevel permission defined: .github/workflows/deploy-release.yml:1","Warn: no topLevel permission defined: .github/workflows/docs.yml:1","Info: no jobLevel write permissions found"],"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":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":4,"reason":"6 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-cpwx-vrp4-4pq7","Warn: Project is vulnerable to: GHSA-gmj6-6f8f-6699","Warn: Project is vulnerable to: GHSA-h5c8-rqwp-cp95","Warn: Project is vulnerable to: GHSA-h75v-3vvj-5mfj","Warn: Project is vulnerable to: GHSA-q2x7-8rv6-6q7h","Warn: Project is vulnerable to: PYSEC-2024-48 / GHSA-fj7x-q9j7-g6q6"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/autofix.yml:9: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/autofix.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/autofix.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/autofix.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/autofix.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/autofix.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:91: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/ci.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-release.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/deploy-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deploy-release.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/deploy-release.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/deploy-release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/deploy-release.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/docs.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/mkdocs/mkdocs/docs.yml/master?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/autofix.yml:16","Warn: pipCommand not pinned by hash: .github/workflows/ci.yml:96","Warn: pipCommand not pinned by hash: .github/workflows/ci.yml:38","Warn: pipCommand not pinned by hash: .github/workflows/ci.yml:65","Warn: pipCommand not pinned by hash: .github/workflows/deploy-release.yml:19","Warn: pipCommand not pinned by hash: .github/workflows/docs.yml:19","Info:   0 out of  13 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   3 third-party GitHubAction dependencies pinned","Info:   0 out of   6 pipCommand dependencies pinned"],"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"}}]},"last_synced_at":"2025-08-21T13:48:04.723Z","repository_id":13148178,"created_at":"2025-08-21T13:48:04.723Z","updated_at":"2025-08-21T13:48:04.723Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27765951,"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-12-16T02:00:10.477Z","response_time":57,"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":["documentation","markdown","mkdocs","python","static-site-generator"],"created_at":"2024-07-30T19:00:22.360Z","updated_at":"2025-12-16T14:03:13.867Z","avatar_url":"https://github.com/mkdocs.png","language":"Python","readme":"# MkDocs\n\n\u003e *Project documentation with Markdown*\n\n[![PyPI Version][pypi-v-image]][pypi-v-link]\n[![Build Status][GHAction-image]][GHAction-link]\n[![Coverage Status][codecov-image]][codecov-link]\n\nMkDocs is a **fast**, **simple** and **downright gorgeous** static site\ngenerator that's geared towards building project documentation. Documentation\nsource files are written in Markdown, and configured with a single YAML\nconfiguration file. It is designed to be easy to use and can be extended with\nthird-party themes, plugins, and Markdown extensions.\n\nPlease see the [Documentation][mkdocs] for an introductory tutorial and a full\nuser guide.\n\n## Features\n\n- Build static HTML files from Markdown files.\n- Use Plugins and Markdown Extensions to enhance MkDocs.\n- Use the built-in themes, third party themes or create your own.\n- Publish your documentation anywhere that static files can be served.\n- Much more!\n\n## Support\n\nIf you need help with MkDocs, do not hesitate to get in contact with us!\n\n-   For questions and high-level discussions, use **[Discussions]** on GitHub.\n    -   For small questions, a good alternative is the **[Chat room]** on\n        Gitter/Matrix.\n-   To report a bug or make a feature request, open an **[Issue]** on GitHub.\n\nPlease note that we may only provide\nsupport for problems/questions regarding core features of MkDocs. Any\nquestions or bug reports about features of third-party themes, plugins,\nextensions or similar should be made to their respective projects.  \nBut, such questions are *not* banned from the [chat room].\n\nMake sure to stick around to answer some questions as well!\n\n## Links\n\n- [Official Documentation][mkdocs]\n- [Latest Release Notes][release-notes]\n- [Catalog of third-party plugins, themes and recipes][catalog]\n\n## Contributing to MkDocs\n\nThe MkDocs project welcomes, and depends on, contributions from developers and\nusers in the open source community. Please see the [Contributing Guide] for\ninformation on how you can help.\n\n## Code of Conduct\n\nEveryone interacting in the MkDocs project's codebases, issue trackers, and\ndiscussion forums is expected to follow the [PyPA Code of Conduct].\n\n\u003c!-- Badges --\u003e\n[codecov-image]: https://codecov.io/github/mkdocs/mkdocs/coverage.svg?branch=master\n[codecov-link]: https://codecov.io/github/mkdocs/mkdocs?branch=master\n[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs.svg\n[pypi-v-link]: https://pypi.org/project/mkdocs/\n[GHAction-image]: https://github.com/mkdocs/mkdocs/actions/workflows/ci.yml/badge.svg\n[GHAction-link]: https://github.com/mkdocs/mkdocs/actions/workflows/ci.yml\n\u003c!-- Links --\u003e\n[mkdocs]: https://www.mkdocs.org\n[Issue]: https://github.com/mkdocs/mkdocs/issues\n[Discussions]: https://github.com/mkdocs/mkdocs/discussions\n[Chat room]: https://gitter.im/mkdocs/community\n[release-notes]: https://www.mkdocs.org/about/release-notes/\n[Contributing Guide]: https://www.mkdocs.org/about/contributing/\n[PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/\n[catalog]: https://github.com/mkdocs/catalog\n\n## License\n\n[BSD-2-Clause](https://github.com/mkdocs/mkdocs/blob/master/LICENSE)\n","funding_links":["https://github.com/sponsors/mkdocs"],"categories":["Python","\u003ca id=\"tag-dev\" href=\"#tag-dev\"\u003eDev\u003c/a\u003e","Uncategorized","JavaScript","Software Engineering","静态站点生成器","Tools for Creating Documentation","语言资源库","documentation","static-site-generator","📦 Additional Python Libraries","Wiki-Server","Documentation","网站生成与排版","General Tools","M"],"sub_categories":["\u003ca id=\"tag-dev.docs\" href=\"#tag-dev.docs\"\u003eDocs\u003c/a\u003e","Uncategorized","Curated Python packages","python","Documentation \u0026 File Processing","静态网站","Site Builder"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocs%2Fmkdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmkdocs%2Fmkdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmkdocs%2Fmkdocs/lists"}