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:
Thanks @jamesmunns! I really appreciate it. And I really am encouraged by this effort. We absolutely want AsciiDoc to be accessible to everyone who wants to write in it, and that means bringing it to new language runtimes.
As for the relationship between Asciidoctor/AsciiDoc, perhaps this section will help: https://docs.asciidoctor.org/asciidoctor/latest/#relationship-to-asciidoc If not, feel free to let me know what isn't clear and I'll happily revise it.
That said, one of the primary goals of the spec is to allow the AsciiDoc format to stand alone, independent of Asciidoctor or any other implementation. We want it to be both consistent and ubiquitous. While there isn't a website to point to yet, there will be soon (as stipulated in our 2021 program plan).
I wholeheartedly welcome those involved in this endeavor to participate in the working group or the language project. But please understand this is merely an invitation, not a requirement or mandate. This is a community effort and just like with all community efforts, it is at will. So tying your funding acceptance criteria to it is not at all necessary (and would likely just complicate things). If you prefer, this project can choose to self-certify using the resources we provide (when the time comes) and leave it at that. It's up to you. Though we really would value your participation in whatever form that may be. After all, the goal is to make AsciiDoc the best it can be.
I can't think of any other concerns at the moment, but we'll be in touch. My door is always open.