Skip to main content

A PyPI package with a Github-Flavored Markdown README

Project description

Github-Flavored Markdown Example Project

No docutils, pandoc, or any other tricks! Just a README.md and a setup.py.

This is forked from @di/markdown-description-example.

See the source for this project here: https://github.com/jonparrott/gfm-markdown-description-example.

Instructions to do this for your project are here: https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi

What we can do:

We can do normal markdown stuff like italics and bold text.

  • Lists
  • Are
  • Fun
  • Too
    • (But please use responsibly)

Code blocks:

>>> pypi_supports_markdown
True

But now you can also do GitHub fun stuff like tables:

foo bar
baz bim

And Strikethrough. And autolinks such as https://blog.jonparrott.com. :)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page