search

pypi / warehouse

The Python Package Index
https://pypi.org
Apache License 2.0
3.51k stars 940 forks source link

Add support for rendering AsciiDoc READMEs? #14712

Open chrysle opened 9 months ago

chrysle commented 9 months ago

What's the problem this feature will solve?

I've seen that AsciiDoc has become a popular markup language for project README files. Would you be potentially interested in maintaining support for a corresponding renderer, given the feature request in pypa/readme_renderer#205 is brought through?

Describe the solution you'd like

Adding AsciiDoc support to the warehouse README backend once the renderer supports it. Note that AsciiDoc does not have a dedicated content type, which could be seen as a downside. Additional context

N/A

di commented 9 months ago

In addition to this requiring support in readme_renderer, we would also need to update the core metadata specifications to provide a Description-Content-Type value that would be a valid content type for AsciiDoc descriptions: https://packaging.python.org/en/latest/specifications/core-metadata/#description-content-type

Marking this blocked on https://github.com/pypa/readme_renderer/issues/205

CarrotManMatt commented 2 months ago

This feature would be greatly appreciated!