Asciidoctor
:gem: A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats. (by asciidoctor)
ansible-doc-generator
CLI for documenting Ansible roles into Markdown files. (by PopulateTools)
Our great sponsors
| Asciidoctor | ansible-doc-generator | |
|---|---|---|
| 34 | 3 | |
| 4,635 | 38 | |
| 1.5% | - | |
| 8.9 | 0.0 | |
| 18 days ago | over 2 years ago | |
| Ruby | Ruby | |
| MIT License | MIT License |
The number of mentions indicates the total number of mentions that we've tracked plus the number of user suggested alternatives.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Asciidoctor
Posts with mentions or reviews of Asciidoctor.
We have used some of these posts to build our list of alternatives
and similar projects. The last one was on 2024-01-25.
-
I don't always use LaTeX, but when I do, I compile to HTML (2013)
You have also AsciiDoctor ( https://asciidoctor.org/ ) which is alive and well. I am using it for technical CS documentation internally, but only for single page documents. I did not try to deploy their whole multi-document setup called Antora ( https://antora.org/ ).
-
[DEV][App Release] Markor 2.11 adds AsciiDoc and CSV Support
AsciiDoc File support. ( #1876, #808, #2022)
-
Documentation generators and custom syntax highlighting
I use Asciidoctor, highlightjs, a custom highlight.js language definition and that bash script:
-
I wish Asciidoc was more popular
AsciiDoc is so close to being good. It slam dunks Markdown, but they just have a few nagging issues that they refuse to fix, for 9 years now:
In fact, also this claim is wrong, because there are three :D
-
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code
Asciidoctor is a Ruby-based text processor for parsing AsciiDoc into a document model and converting it to HTML5, PDF, EPUB3, and other formats. Built-in converters for HTML5, DocBook5, and man pages are available in Asciidoctor. Asciidoctor has an out-of-the-box default stylesheet and built-in integrations for MathJax (display beautiful math in your browser), highlight.js, Rouge, and Pygments (syntax highlighting), as well as Font Awesome (for icons). Although Asciidoctor is written in Ruby, that does not mean you need to know Ruby to use it. Asciidoctor can be executed on a JVM using AsciidoctorJ or in any JavaScript environment (including the browser) using Asciidoctor.js. You can choose any one of three Asciidoctor processors (Ruby, JavaScript, Java/JVM) and get the same experience. You can also use the Asciidoctor Maven Plugin to convert your Asciidoc documentation using Asciidoctor from an Apache Maven build.
-
Designing Go Libraries: The Talk: The Article
asciidoctor for writing
-
Docs as code vs a tool that can work with .md and xml?
If you're looking at AsciiDoc, you'll want to look at Asciidoctor: https://asciidoctor.org/
- Diving deeper into custom PDF and ePub generation
-
Mau: a lightweight markup language based on Jinja
The third system that I found was AsciiDoc, which started as a Python project, abandoned for a while and eventually resurrected by Dan Allen with Asciidoctor. AsciiDoc has a lot of features and I consider it superior to Markdown, but Asciidoctor is a Ruby program, and this made it difficult for me to use it. In addition, the standard output of Asciidoctor is a nice single HTML page but again customising it is a pain. I eventually created the site of the book using it, but adding my Google Analytics code and a sitemap.xml to the HTML wasn't trivial, not to mention customising the look of elements such as admonitions.
ansible-doc-generator
Posts with mentions or reviews of ansible-doc-generator.
We have used some of these posts to build our list of alternatives
and similar projects.
We haven't tracked posts mentioning ansible-doc-generator yet.
Tracking mentions began in Dec 2020.
What are some alternatives?
When comparing Asciidoctor and ansible-doc-generator you can also consider the following projects:
RDoc - RDoc produces HTML and online documentation for Ruby projects.
Zettlr - Your One-Stop Publication Workbench
plantuml - Generate diagrams from textual description
hugo-PaperMod - A fast, clean, responsive Hugo theme.
pandoc - Universal markup converter
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
YARD - YARD is a Ruby Documentation tool. The Y stands for "Yay!"
wavedrom - :ocean: Digital timing diagram rendering engine
grape-swagger - Add OAPI/swagger v2.0 compliant documentation to your grape API
Annotate - Annotate Rails classes with schema and routes info
Inch - A documentation analysis tool for the Ruby language
Apipie - Ruby on Rails API documentation tool