https://github.com/Python-Markdown/markdown

A Python implementation of John Gruber’s Markdown with Extension support.
https://github.com/Python-Markdown/markdown

markdown markdown-parser markdown-to-html python python-markdown python3

Last synced: 8 days ago
JSON representation

A Python implementation of John Gruber’s Markdown with Extension support.

• Host: GitHub
• URL: https://github.com/Python-Markdown/markdown
• Owner: Python-Markdown
• License: bsd-3-clause
• Created: 2010-05-29T02:59:45.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2024-10-01T17:06:59.000Z (about 1 month ago)
• Last Synced: 2024-10-29T14:04:59.065Z (10 days ago)
• Topics: markdown, markdown-parser, markdown-to-html, python, python-markdown, python3
• Language: Python
• Homepage: https://python-markdown.github.io/
• Size: 3.43 MB
• Stars: 3,785
• Watchers: 75
• Forks: 862
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• my-awesome-starred - Python-Markdown/markdown - A Python implementation of John Gruber’s Markdown with Extension support. (Python)
• awesome-markdown - Python-Markdown - Python implementation of John Gruber's Markdown. (Libraries / Python)
• best-of-web-python - GitHub - 2% open · ⏱️ 25.04.2024): (Markdown)
• awesome-web-editor - markdown - A Python implementation of John Gruber’s Markdown with Extension support. (Markdown parser)

README

        
[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 .

[installation]: https://python-markdown.github.io/install/

[usage]: https://python-markdown.github.io/reference/

See the change log at .

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 code bases, issue trackers,

and mailing lists is expected to follow the [Code of Conduct].