search

pypa / readme_renderer

Safely render long_description/README files in Warehouse
Apache License 2.0
158 stars 88 forks source link

AsciiDoc support #205

Open senier opened 2 years ago

senier commented 2 years ago

It would be great if readme_renderer supported AsciiDoc natively. It has some very neat features and it would be nice to use the same format for our README as well as for the rest of the documentation. There is AsciiDoc3 to handle AsciiDoc in Python.

chrysle commented 8 months ago

I'll work on this.

chrysle commented 8 months ago

There is one complication I'd like to discuss before implementing anything. Related: asciidoctor/asciidoctor#3340

The Python port of AsciiDoc, AsciiDoc.py (legacy processor, asciidoc3 is based on that and was just ported earlier to Python 3. Also it seems to have fallen behind the better developed asciidoc.), isn't totally compliant with the latest AsciiDoctor language spec - although that is on their roadmap.

However with this in mind I don't see any alternative to just creating the renderer on top of the Python implementation and pointing out it only supports the spec published by the AsciiDoc.py project until they have caught up.

@di @miketheman What do you think?

lfvjimisola commented 8 months ago

There has been a discussion about this in the AsciiDoc ZulipChat forum with @mojavelinux among others.

The lack of an updated python implementation is a clear issue. The is a Language Specification is in progress and once that is finalized implementations in other languages can be implemented.

I'm not sure how much difference there is between AsciiDoc.py and AsciiDoctor, but work case is that AsciiDoc.py is a AsciiDoc-flavor nowadays.

chrysle commented 5 days ago

Gentle ping on this @pypa/readme_renderer-committers.