python-mkdocs
Port variant v11
Summary Project documentation with Markdown (3.11)
BROKEN
Package version 1.6.1
Homepage No known homepage
Keywords python
Maintainer Python Automaton
License Not yet specified
Other variants v12
Ravenports Buildsheet | History
Ravensource Port Directory | History
Last modified 07 SEP 2024, 17:00:23 UTC
Port created 01 JAN 2023, 17:21:46 UTC
Subpackage Descriptions
single # 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]
Configuration Switches (platform-specific settings discarded)
PY311 ON Build using Python 3.11 PY312 OFF Build using Python 3.12
Package Dependencies by Type
Build (only) python-pip:single:v11
autoselect-python:single:std
Build and Runtime python311:single:std
Runtime (only) python-click:single:v11
python-ghp-import:single:v11
python-Jinja2:single:v11
python-Markdown:single:v11
python-MarkupSafe:single:v11
python-mergedeep:single:v11
python-mkdocs-get-deps:single:v11
python-packaging:single:v11
python-pathspec:single:v11
python-pyyaml-env-tag:single:v11
python-PyYAML:single:v11
python-watchdog:single:v11
Download groups
main mirror://PYPIWHL/22/5b/dbc6a8cddc9cfa9c4971d59fb12bb8d42e161b7e7f8cc89e49137c5b279c
Distribution File Information
db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e 3864451 mkdocs-1.6.1-py3-none-any.whl
Ports that require python-mkdocs:v11
python-mkdocs-autorefs:v11 Automatically link across pages in MkDocs (3.11)
python-mkdocs-material:v11 Documentation that simply works (3.11)
python-mkdocstrings:v11 Documentation from sources for MkDocs (3.11)