Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkdocs/mkdocs
Project documentation with Markdown.
https://github.com/mkdocs/mkdocs
documentation markdown mkdocs python static-site-generator
Last synced: 6 days ago
JSON representation
Project documentation with Markdown.
- Host: GitHub
- URL: https://github.com/mkdocs/mkdocs
- Owner: mkdocs
- License: bsd-2-clause
- Created: 2014-01-11T21:05:21.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T19:42:20.000Z (7 months ago)
- Last Synced: 2024-04-14T02:55:09.962Z (7 months ago)
- Topics: documentation, markdown, mkdocs, python, static-site-generator
- Language: Python
- Homepage: https://www.mkdocs.org
- Size: 31.2 MB
- Stars: 18,205
- Watchers: 235
- Forks: 2,348
- Open Issues: 112
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - mkdocs - Project documentation with Markdown. (Python)
- my-awesome-starred - mkdocs - Project documentation with Markdown. (Python)
- awesome-python-applications - Repo - in dev server. `(console)` (<a id="tag-dev" href="#tag-dev">Dev</a> / <a id="tag-dev.docs" href="#tag-dev.docs">Docs</a>)
- awesome-translation - MkDocs
- awesome-translation - MkDocs
- awesome-starred-test - mkdocs/mkdocs - Project documentation with Markdown. (Python)
- awesome-starred - mkdocs/mkdocs - Project documentation with Markdown. (markdown)
- best-of-python-dev - GitHub - 3% open · ⏱️ 10.05.2024): (Documentation)
- awesome-python-applications - Repo - in dev server. `(console)` (<a id="tag-dev" href="#tag-dev">Dev</a> / <a id="tag-dev.docs" href="#tag-dev.docs">Docs</a>)
- awesome-python-again -
- starred-awesome - mkdocs - Project documentation with Markdown. (JavaScript)
- awesome - mkdocs - Project documentation with Markdown. (Python)
- awesome - mkdocs/mkdocs - Project documentation with Markdown. (Python)
- my-awesome - mkdocs/mkdocs - site-generator pushed_at:2024-08 star:19.3k fork:2.4k Project documentation with Markdown. (Python)
- awesome-ops - mkdocs/mkdocs - 2-Clause|19186|2014-01-11|2024-08-30 | MkDocs 是一个快速、简单且华丽的静态站点生成器，适用于构建项目文档。文档源文件是用 Markdown 编写的，并使用单个 YAML 配置文件进行配置。它的设计易于使用，并且可以通过第三方主题、插件和 Markdown 扩展进行扩展。 | (Wiki-Server)
- jimsghstars - mkdocs/mkdocs - Project documentation with Markdown. (Python)
- awesome-documentation - MkDocs - A fast, simple and downright gorgeous static site generator that's geared towards building project documentation. (General Tools / Site Builder)
- awesome - mkdocs/mkdocs - Project documentation with Markdown. (Python)
- awesome - mkdocs/mkdocs - Project documentation with Markdown. (Python)
- awesomeLibrary - mkdocs - Project documentation with Markdown. (语言资源库 / python)
README
# 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].
[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
[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)