On 2021-01-17, @bitshiftmask requested an open source implementation of the AsciiDoc format.
Please see the original twitter thread for details.
The project is currently being developed here on GitHub.
NOTE: The repo/library name is likely to change in the near future to avoid Trademark Confusion. The link above will be changed once that has happened.
If you would like to add your pledge, please DM James on twitter, or reply to the thread. We are still looking for more contributions, to help prioritize or accelerate the work!
All of the following deliverables have the following requirements:
- The deliverables must be developed under a permissive open source license
- Ideally this would be dual MIT+Apache 2.0
- If you'd like to use another license, please check with James first.
- Both components must be completely written in Rust, and must not wrap a non-Rust library or CLI program.
- All work must be public, at least at the time of release/acceptance
Your work will be reviewed prior to acceptance of payment. You must be listed on this page under "Implementors" to be elligible for the payment.
We are currently tracking the following deliverables
A syntax parser for the AsciiDoc format, implemented in pure Rust.
The parser should have tests verifying its compliance with at least one common flavor of the AsciiDoc format.
Concrete acceptance criteria is under development.
Supporters for this deliverable:
- @bitshiftmask - 250 EUR
- @HeavyPackets - 250 EUR
- @Argorak - 250 EUR
- @bobmcwhirter - 250 EUR
The total support for this deliverable is currently 1000 EUR.
Support for this AsciiDoc syntax parser for the mdbook tool.
The mdbook support does not need to be merged upstream, but does need to be submitted.
Concrete acceptance criteria is under development.
Supporters for this deliverable:
- @bitshiftmask - 250 EUR
- @HeavyPackets - 250 EUR
- @Argorak - 250 EUR
The total support for this deliverable is currently 750 EUR.
The parser (deliverable #1) should be equipped for format-preserving re-serialization.
Concrete acceptance criteria is under development.
Supporters for this deliverable:
- @Argorak - 250 EUR
The total support for this deliverable is currently 250 EUR.
This amount is being paid by individuals that are pledging their amounts. This money will be paid out by each individual independently. James cannot control the individuals pledging, but will make a best effort to follow up with them once payment is due.
Please see above for the current pledge amounts.
If you would like to add your pledge, please DM James on twitter, or reply to the thread. We are still looking for more contributions, to help prioritize or accelerate the work!
Currently, Lukas Wirth (GitHub, Twitter) has been assigned as the primary implementor. At the moment, he plans to take this commission on as a solo developer.
The project is currently being developed here on GitHub.
In the case that Lukas is unable to continue or finish development of the deliverables above, or is looking for potential collaborators, we are looking for interested alternates! If you are interested, please DM James for more details.
The following people have contacted James as potentially interested in helping:
Hello. I came here after seeing a comment on @Veykril's project saying "see the linked gist if you are interested in taking over the project instead".
I am interested in this project. In the past week or so, I have written a process to convert an AsciiDoc document to Markdown for rust-analyzer's release notes (but I am not sure yet if this PR will be accepted). This process was implemented based on the documentation on AsciiDoctor's site, and it handles the limited source documentation in a nice way. However, it contains some ad hoc parts and I wanted to create a more decent parser. I found @Veykril's project while researching existing projects and ended up here.
I am a solo open source developer with a company job that deals primarily with binary data, and also have a translation book manuscript, so I can't devote full time to this project. However, I am very interested in participating as an implementer, as I would like to use AsciiDoc more in the Rust community and would be happy to use AsciiDoc in mdBook as well. Note that I have used the AsciiDoc format in my manuscripts, so I have some understanding of it, but I am still refining the details by reading AsciiDoctor's documentation.