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


Release history Release notifications

This version
History Node

0.0.2

History Node

0.0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
gfm-markdown-description-example-0.0.2.tar.gz (1.5 kB) Copy SHA256 hash SHA256 Source None Apr 2, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page