Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

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.

Files for gfm-markdown-description-example, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size gfm-markdown-description-example-0.0.2.tar.gz (1.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page