#798 Add AsciiDoc support for README files
Opened 8 years ago by ricardo. Modified a year ago

AsciiDoc should be a supported format for README files.

More info:
http://asciidoctor.org/docs/what-is-asciidoc/


That's a nice idea, I have a few questions though:

  • Is there a python library to do the conversion?
  • What would the filename extension be like?

Finally, is this something you would be interesting to implement yourself? I'm up for helping you with it :)

@immanetize ping

@pingou docs is using AsciiDoc as a format moving forward. Can this get prioritized?

Well both of my questions haven't been answered :)

So it seems to be a asciidocapi module according to this
you get it when you install the asciidoc rpm.
And the filename extension is .txt

I ll do a bit more investigation

asciidoctor is what the RH MW team uses. http://asciidoctor.org/docs/asciidoc-asciidoctor-diffs/

I don't know about a python library. Seems like it moved off python. Perhaps using an external process is an option? I mean, there might be some python solution but I doub;t it will be well supported.

wrt file extensions, that would definitely be .adoc

AsciiDoc is in Python itself, and there's a Python 3 port in progress: https://github.com/asciidoc/asciidoc-py3

If we're ok with doing this in JS, it looks like https://github.com/asciidoctor/asciidoctor.js may be a good fit.

So it seems to be a asciidocapi module according to this

Looking at the Home of the doc at: http://www.methods.co.nz/asciidoc/index.html I see: 9 November 2013: AsciiDoc 8.6.9 Released. So that's about 5 years without a release :(

If we're ok with doing this in JS, it looks like https://github.com/asciidoctor/asciidoctor.js may be a good fit.

This should be a great library. It is, iirc, by the folks behind asciidoctor and antora. MojaveLinux is a serious contributor.

So it seems to be a asciidocapi module according to this

Looking at the Home of the doc at: http://www.methods.co.nz/asciidoc/index.html I see: 9 November 2013: AsciiDoc 8.6.9 Released. So that's about 5 years without a release :(

This asciidoc is deprecated and replaced by asciidoctor. I am not sure of the politics for why this site has not been taken offline.

this issue is gathering interest +1

More and more Fedora stuff is moved to asciidoctor. Can we prioritize this please?

  • no, there is AFAIK no Python library, use subprocess or asyncio subprocess and the asciidoctor command
  • the extension is .adoc

no update since 3 years but let's but it in the 6.0 milestone and decide later

Metadata Update from @wombelix:
- Issue set to the milestone: 6.0

a year ago

One of the issue with this was the lack of python library support asciidoc.
A quick search today raises: https://pypi.org/project/asciidoc3/ but last update
December 2021 is not appealing.
https://pypi.org/project/asciidoc/ might be better there (last release may
2022).
Could be worth a check

Login to comment on this ticket.

Metadata