Asciidoctor
commonmark-spec
Our great sponsors
Asciidoctor | commonmark-spec | |
---|---|---|
34 | 48 | |
4,641 | 4,832 | |
1.6% | 0.4% | |
8.7 | 6.9 | |
27 days ago | 3 months ago | |
Ruby | Python | |
GNU General Public License v3.0 or later | GNU General Public License v3.0 or later |
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
-
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)
-
Good software/SaaS for Technical Documentation CMS
If Maths is important to you, take a look at Asciidoc - https://asciidoctor.org/
-
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:
https://github.com/asciidoctor/asciidoctor/issues/1087
-
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.
commonmark-spec
-
How to add a man page to your Ruby project, using kramdown-man and markdown
Edit: this is because GitHub uses cmark-gfm, which is a fork of cmark, which implements the CommonMark variant of markdown. Looks like CommonMark still doesn't support definition lists. :(
-
How do you host documentation for your spouse or other users?
BookStack dev here. There's no specific "import" option but you can use the Markdown editor in BookStack and paste in your Markdown content there. The API is essentially just an endpoint to accept the same kind of data, for of course you could automate against the API for batch import. One thing to keep in mind is that BookStack markdown support is fairly tightly scoped to (commonmark + tables + tasklists), although HTML within MD is supported.
-
On why Markdown is not a good, or even a half-decent, markup language
>A single canonical reference
https://commonmark.org/
-
Get ready for Bear 2 - We have a quick blog post with some important details and ways you can get notified once it's out!
Typically with major new releases of software, when the number left of the dot (e.g. 2.0) increases, it’s shipped as a separate product. Not always, but generally. The Bear folks can speak for themselves but IIRC a lot of the code was refactored / rewritten to support, for example, CommonMark. So, under the hood, it’s literally brand new in some respects.
-
Best website to write a rulebook for ttrpgs
I use Obsidian (https://obsidian.md) for a lot of things, including my RPG stuff, and there are options for exporting things as PDFs. It’s great for getting organized and doing research, but I would use other tools for long-form writing and layout. What I like about Obsidian though is that everything is done in Markdown (https://commonmark.org) and I can use Pandoc (https://pandoc.org) to transform the source to whatever I need. The caveat is that Obsidian uses a flavor of Markdown with some non-standard extensions, so a pure Markdown editor like Typora (https://typora.io) might be a better choice depending on your needs.
- What is the most minimal, strictest variant of Markdown?
-
How to display an image
yes, this is the "inventor" of markdown and those rules will always work. Hugo uses something called "Commonmark" which is developed on top of the original markdown. But the original rules will always work too.
-
Lightweight Markup for Ukrainian Texts?
Reddit and many other sites support Markdown as an easy way to add emphasis, links, headings, etc. Markdown does not contain any keywords, as it is intended to be language-independent. However, Markdown syntax makes heavy use of square brackets [] and other characters that are difficult to type with an Ukrainian keyboard layout, e.g., the backtick `.
-
I wish Asciidoc was more popular
Check out commonmark, that is the Markdown standard supported by numerous converters including pandoc.
-
I wrote a markdown to html converter
And if this is an exercise into that you can use a Markdown spec like CommonMark which is the spec Reddit and a variety of other sites use.
What are some alternatives?
RDoc - RDoc produces HTML and online documentation for Ruby projects.
pandoc - Universal markup converter
Zettlr - Your One-Stop Publication Workbench
kramdown - kramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and supporting several common extensions.
plantuml - Generate diagrams from textual description
marktext - 📝A simple and elegant markdown editor, available for Linux, macOS and Windows.
ansible-doc-generator - CLI for documenting Ansible roles into Markdown files.
markdown-it-katex - Add Math to your Markdown with a KaTeX plugin for Markdown-it
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
Joplin - Joplin - the secure note taking and to-do app with synchronisation capabilities for Windows, macOS, Linux, Android and iOS.
hugo-PaperMod - A fast, clean, responsive Hugo theme.
rehype-sanitize - plugin to sanitize HTML