| [Python-Markdown][] |
| =================== |
| |
| [![Build Status][build-button]][build] |
| [![Coverage Status][codecov-button]][codecov] |
| [![Latest Version][mdversion-button]][md-pypi] |
| [![Python Versions][pyversion-button]][md-pypi] |
| [![BSD License][bsdlicense-button]][bsdlicense] |
| [![Code of Conduct][codeofconduct-button]][Code of Conduct] |
| |
| [build-button]: https://github.com/Python-Markdown/markdown/workflows/CI/badge.svg?event=push |
| [build]: https://github.com/Python-Markdown/markdown/actions?query=workflow%3ACI+event%3Apush |
| [codecov-button]: https://codecov.io/gh/Python-Markdown/markdown/branch/master/graph/badge.svg |
| [codecov]: https://codecov.io/gh/Python-Markdown/markdown |
| [mdversion-button]: https://img.shields.io/pypi/v/Markdown.svg |
| [md-pypi]: https://pypi.org/project/Markdown/ |
| [pyversion-button]: https://img.shields.io/pypi/pyversions/Markdown.svg |
| [bsdlicense-button]: https://img.shields.io/badge/license-BSD-yellow.svg |
| [bsdlicense]: https://opensource.org/licenses/BSD-3-Clause |
| [codeofconduct-button]: https://img.shields.io/badge/code%20of%20conduct-contributor%20covenant-green.svg?style=flat-square |
| [Code of Conduct]: https://github.com/Python-Markdown/markdown/blob/master/CODE_OF_CONDUCT.md |
| |
| This is a Python implementation of John Gruber's [Markdown][]. |
| It is almost completely compliant with the reference implementation, |
| though there are a few known issues. See [Features][] for information |
| on what exactly is supported and what is not. Additional features are |
| supported by the [Available Extensions][]. |
| |
| [Python-Markdown]: https://Python-Markdown.github.io/ |
| [Markdown]: https://daringfireball.net/projects/markdown/ |
| [Features]: https://Python-Markdown.github.io#Features |
| [Available Extensions]: https://Python-Markdown.github.io/extensions |
| |
| Documentation |
| ------------- |
| |
| ```bash |
| pip install markdown |
| ``` |
| ```python |
| import markdown |
| html = markdown.markdown(your_text_string) |
| ``` |
| |
| For more advanced [installation] and [usage] documentation, see the `docs/` directory |
| of the distribution or the project website at <https://Python-Markdown.github.io/>. |
| |
| [installation]: https://python-markdown.github.io/install/ |
| [usage]: https://python-markdown.github.io/reference/ |
| |
| See the change log at <https://Python-Markdown.github.io/change_log>. |
| |
| Support |
| ------- |
| |
| You may report bugs, ask for help, and discuss various other issues on the [bug tracker][]. |
| |
| [bug tracker]: https://github.com/Python-Markdown/markdown/issues |
| |
| Code of Conduct |
| --------------- |
| |
| Everyone interacting in the Python-Markdown project's codebases, issue trackers, |
| and mailing lists is expected to follow the [Code of Conduct]. |