[RFC] can the project main page can support markdown ?

[ghost]

Hello , dear develop community.

Can we support markdown at the project home page?

https://pypi.org/project/py-cn-phone-area-code/

I want put very simple example to show user how to play with my lib.

[brainwane]

Hi, @netroby.

We're working on supporting Markdown, but we don't have it yet. My colleague Dustin is working on several tasks that need to all be completed before you can have Markdown in your project's main PyPI page. #869 (comment) is the comment where he lists out those tasks. You can subscribe to that issue on GitHub to get a notification when it's fixed and resolved.

https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi may help you -- also, you might like to use pandoc so you can write Markdown and then turn it into reStructuredText for the README.

Best wishes. I'm closing this as a duplicate, but thank you for sharing your needs, and for using PyPI.