| Name | mkdocs JSON |
| Version |
1.6.1
JSON |
| download |
| home_page | None |
| Summary | Project documentation with Markdown. |
| upload_time | 2024-08-30 12:24:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# MkDocs
> *Project documentation with Markdown*
[![PyPI Version][pypi-v-image]][pypi-v-link]
[![Build Status][GHAction-image]][GHAction-link]
[![Coverage Status][codecov-image]][codecov-link]
MkDocs is a **fast**, **simple** and **downright gorgeous** static site
generator that's geared towards building project documentation. Documentation
source files are written in Markdown, and configured with a single YAML
configuration file. It is designed to be easy to use and can be extended with
third-party themes, plugins, and Markdown extensions.
Please see the [Documentation][mkdocs] for an introductory tutorial and a full
user guide.
## Features
- Build static HTML files from Markdown files.
- Use Plugins and Markdown Extensions to enhance MkDocs.
- Use the built-in themes, third party themes or create your own.
- Publish your documentation anywhere that static files can be served.
- Much more!
## Support
If you need help with MkDocs, do not hesitate to get in contact with us!
- For questions and high-level discussions, use **[Discussions]** on GitHub.
- For small questions, a good alternative is the **[Chat room]** on
Gitter/Matrix.
- To report a bug or make a feature request, open an **[Issue]** on GitHub.
Please note that we may only provide
support for problems/questions regarding core features of MkDocs. Any
questions or bug reports about features of third-party themes, plugins,
extensions or similar should be made to their respective projects.
But, such questions are *not* banned from the [chat room].
Make sure to stick around to answer some questions as well!
## Links
- [Official Documentation][mkdocs]
- [Latest Release Notes][release-notes]
- [Catalog of third-party plugins, themes and recipes][catalog]
## Contributing to MkDocs
The MkDocs project welcomes, and depends on, contributions from developers and
users in the open source community. Please see the [Contributing Guide] for
information on how you can help.
## Code of Conduct
Everyone interacting in the MkDocs project's codebases, issue trackers, and
discussion forums is expected to follow the [PyPA Code of Conduct].
<!-- Badges -->
[codecov-image]: https://codecov.io/github/mkdocs/mkdocs/coverage.svg?branch=master
[codecov-link]: https://codecov.io/github/mkdocs/mkdocs?branch=master
[pypi-v-image]: https://img.shields.io/pypi/v/mkdocs.svg
[pypi-v-link]: https://pypi.org/project/mkdocs/
[GHAction-image]: https://github.com/mkdocs/mkdocs/workflows/CI/badge.svg?branch=master&event=push
[GHAction-link]: https://github.com/mkdocs/mkdocs/actions?query=event%3Apush+branch%3Amaster
<!-- Links -->
[mkdocs]: https://www.mkdocs.org
[Issue]: https://github.com/mkdocs/mkdocs/issues
[Discussions]: https://github.com/mkdocs/mkdocs/discussions
[Chat room]: https://gitter.im/mkdocs/community
[release-notes]: https://www.mkdocs.org/about/release-notes/
[Contributing Guide]: https://www.mkdocs.org/about/contributing/
[PyPA Code of Conduct]: https://www.pypa.io/en/latest/code-of-conduct/
[catalog]: https://github.com/mkdocs/catalog
## License
[BSD-2-Clause](https://github.com/mkdocs/mkdocs/blob/master/LICENSE)
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Tom Christie <tom@tomchristie.com>",
"download_url": "https://files.pythonhosted.org/packages/bc/c6/bbd4f061bd16b378247f12953ffcb04786a618ce5e904b8c5a01a0309061/mkdocs-1.6.1.tar.gz",
"platform": null,
"description": "# MkDocs\n\n> *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<!-- Badges -->\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/workflows/CI/badge.svg?branch=master&event=push\n[GHAction-link]: https://github.com/mkdocs/mkdocs/actions?query=event%3Apush+branch%3Amaster\n<!-- Links -->\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",
"bugtrack_url": null,
"license": null,
"summary": "Project documentation with Markdown.",
"version": "1.6.1",
"project_urls": {
"Documentation": "https://www.mkdocs.org/",
"History": "https://www.mkdocs.org/about/release-notes/",
"Issues": "https://github.com/mkdocs/mkdocs/issues",
"Source": "https://github.com/mkdocs/mkdocs"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "225bdbc6a8cddc9cfa9c4971d59fb12bb8d42e161b7e7f8cc89e49137c5b279c",
"md5": "1be8948ff4d3b56acb477961f6483410",
"sha256": "db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e"
},
"downloads": -1,
"filename": "mkdocs-1.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1be8948ff4d3b56acb477961f6483410",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 3864451,
"upload_time": "2024-08-30T12:24:05",
"upload_time_iso_8601": "2024-08-30T12:24:05.054260Z",
"url": "https://files.pythonhosted.org/packages/22/5b/dbc6a8cddc9cfa9c4971d59fb12bb8d42e161b7e7f8cc89e49137c5b279c/mkdocs-1.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bcc6bbd4f061bd16b378247f12953ffcb04786a618ce5e904b8c5a01a0309061",
"md5": "aad5d11eaa821d4edde85ad429a96f05",
"sha256": "7b432f01d928c084353ab39c57282f29f92136665bdd6abf7c1ec8d822ef86f2"
},
"downloads": -1,
"filename": "mkdocs-1.6.1.tar.gz",
"has_sig": false,
"md5_digest": "aad5d11eaa821d4edde85ad429a96f05",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 3889159,
"upload_time": "2024-08-30T12:24:06",
"upload_time_iso_8601": "2024-08-30T12:24:06.899675Z",
"url": "https://files.pythonhosted.org/packages/bc/c6/bbd4f061bd16b378247f12953ffcb04786a618ce5e904b8c5a01a0309061/mkdocs-1.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-30 12:24:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mkdocs",
"github_project": "mkdocs",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "mkdocs"
}
