Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AsciiDoc support #205

Open
senier opened this issue Jul 27, 2021 · 4 comments
Open

AsciiDoc support #205

senier opened this issue Jul 27, 2021 · 4 comments

Comments

@senier
Copy link

senier commented Jul 27, 2021

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
Copy link

chrysle commented Oct 9, 2023

I'll work on this.

@chrysle
Copy link

chrysle commented Oct 11, 2023

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
Copy link

lfvjimisola commented Oct 12, 2023

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
Copy link

chrysle commented Jun 29, 2024

Gentle ping on this @pypa/readme_renderer-committers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants