diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 55 |
1 files changed, 33 insertions, 22 deletions
@@ -1,45 +1,56 @@ [Python-Markdown][] =================== -[](https://travis-ci.org/Python-Markdown/markdown) -[](https://codecov.io/gh/Python-Markdown/markdown) -[](http://pypi.python.org/pypi/Markdown) -[](http://pypi.python.org/pypi/Markdown) -[](http://opensource.org/licenses/BSD-3-Clause) -[][Code of Conduct] - -This is a Python implementation of John Gruber's [Markdown][]. +[![Build Status][travis-button]][travis] +[![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] + +[travis-button]: http://img.shields.io/travis/Python-Markdown/markdown.svg +[travis]: https://travis-ci.org/Python-Markdown/markdown +[codecov-button]: https://codecov.io/gh/Python-Markdown/markdown/branch/master/graph/badge.svg +[codecov]: https://codecov.io/gh/Python-Markdown/markdown +[mdversion-button]: http://img.shields.io/pypi/v/Markdown.svg +[md-pypi]: http://pypi.python.org/pypi/Markdown +[pyversion-button]: http://img.shields.io/pypi/pyversions/Markdown.svg +[bsdlicense-button]: http://img.shields.io/badge/license-BSD-yellow.svg +[bsdlicense]: http://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 +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://pythonhosted.org/Markdown/ +[Python-Markdown]: https://Python-Markdown.github.io/ [Markdown]: http://daringfireball.net/projects/markdown/ -[Features]: https://pythonhosted.org/Markdown/index.html#Features -[Available Extensions]: https://pythonhosted.org/Markdown/extensions/index.html - +[Features]: https://Python-Markdown.github.io#Features +[Available Extensions]: https://Python-Markdown.github.io/extensions Documentation ------------- Installation and usage documentation is available in the `docs/` directory -of the distribution and on the project website at -<https://pythonhosted.org/Markdown/>. +of the distribution and on the project website at +<https://Python-Markdown.github.io/>. -See the change log at <https://pythonhosted.org/Markdown/change_log.html>. +See the change log at <https://Python-Markdown.github.io/change_log>. Support ------- -You may ask for help and discuss various other issues on the [mailing list][] and report bugs on the [bug tracker][]. +You may ask for help and discuss various other issues on the [mailing list][] +and report bugs on the [bug tracker][]. [mailing list]: http://lists.sourceforge.net/lists/listinfo/python-markdown-discuss -[bug tracker]: http://github.com/Python-Markdown/markdown/issues +[bug tracker]: http://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]. - -[Code of Conduct]: https://github.com/Python-Markdown/markdown/blob/master/CODE_OF_CONDUCT.md +Everyone interacting in the Python-Markdown project's codebases, issue trackers, +and mailing lists is expected to follow the [Code of Conduct]. |