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 | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file gfm-markdown-description-example-0.0.2.tar.gz
.
File metadata
- Download URL: gfm-markdown-description-example-0.0.2.tar.gz
- Upload date:
- Size: 1.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60916718863b937ac5390e8c1ca4d3dcd3b532d8386b78d9a11164f4e6e6e060 |
|
MD5 | 82ffce2dcdd589b1ed2eced4d3118496 |
|
BLAKE2b-256 | aa6e05865a61b142381bf30225987ae12e4f5683136af0cbb1dc8041b09ff795 |