Asciidoctor
pandoc
Our great sponsors
Asciidoctor | pandoc | |
---|---|---|
34 | 420 | |
4,641 | 32,396 | |
1.6% | - | |
8.7 | 9.8 | |
27 days ago | 2 days ago | |
Ruby | Haskell | |
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.
pandoc
-
Beautifying Org Mode in Emacs (2018)
My main authoring tool is then Emacs Markdown Mode (https://jblevins.org/projects/markdown-mode/). For data entry, it comes with some bells and whistles similar to org-mode, like C-c C-l for inserting links etc.
I seldom export my notes for external usage, but if it is the case, I use lowdown (https://kristaps.bsd.lv/lowdown/) which also comes with some nice output targets (among the more unusual are Groff and Terminal). Of cource pandoc (https://pandoc.org/) does a very good job here, too.
-
Show HN: I made a tool to clean and convert any webpage to Markdown
This is one of those things that the ever-amazing pandoc (https://pandoc.org/) does very well, on top of supporting virtually every other document format.
-
LaTeX makes me so angry at word
Folks feel the same way about Markdown versus LaTeX: why use something significantly more complicated where a looser, human-readable grammar works better?
For any other situations, I use https://pandoc.org/, or, generate a Word doc scriptomatically.
-
📓 Versionner et builder l'eBook de son Entretien Annuel d'Evaluation sur Git(Hub)
pandoc toolchain pour builder une version confortable/imprimable en phase de travail (ePub, pdf, docx, html)
-
Launch HN: Onedoc (YC W24) – A better way to create PDFs
Congrats on the launch, I guess, but there are so many free options that I can't think of a situation where paying $0.25 per document would be justified...? Just to name a few:
Back in the days, I used to use XSL-FO [0] and it was okay. It was not very precise but it rarely if ever broke, and was perfectly integrated with an XML/XSLT solution. Yeah, this was a long time ago.
Last month I used html-to-pdfmake [1] and it's also not very precise and more fragile, but very efficient and fast.
Yet another approach would be to pro grammatically generate .rtf files (for example) and use Pandoc [2] to produce PDFs (I have not tried this in production but don't see why it wouldn't work).
[0] https://en.wikipedia.org/wiki/XSL_Formatting_Objects
[1] https://www.npmjs.com/package/html-to-pdfmake
[2] https://pandoc.org/
-
Ask HN: Looking for lightweight personal blogging platform
Others have mentioned static site generators. I like Hakyll [1] because it can tightly integrate with Pandoc [2] and allows you to develop custom solutions if your needs ever grow.
[1]: https://jaspervdj.be/hakyll/
[2]: https://pandoc.org/
-
Show HN: CLI for generating beautiful PDF for offline reading
Have you compared it with a conversion by pandoc (https://pandoc.org/)?
-
Pandoc
I have used it to kickstart a blogging project that I wish to come back to soon. The Lua inter-op for custom readers, writers and filters is great but I wish there was more editor integration and even perhaps an official IDE/editor with built-in debugging features (probably something already do-able with Emacs but I haven't checked). The only blocker for my project is no support for "ChunkedDoc" for Lua filters [1] which forces me to write more code and a complicated Makefile.
[1]: https://github.com/jgm/pandoc/issues/9061
- I don't always use LaTeX, but when I do, I compile to HTML (2013)
- What Happened to Pandoc-Discuss?
What are some alternatives?
RDoc - RDoc produces HTML and online documentation for Ruby projects.
pandoc-highlighting-extensions - Extensions to Pandoc syntax highlighting
Zettlr - Your One-Stop Publication Workbench
obsidian-html - :file_cabinet: A simple tool to convert an Obsidian vault into a static directory of HTML files.
plantuml - Generate diagrams from textual description
obsidian-export - Rust library and CLI to export an Obsidian vault to regular Markdown
ansible-doc-generator - CLI for documenting Ansible roles into Markdown files.
Obsidian-MD-To-PDF - A command line python script to convert Obsidian md files to a pdf
GitHub Changelog Generator - Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
kramdown - kramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and supporting several common extensions.
hugo-PaperMod - A fast, clean, responsive Hugo theme.
wavedrom - :ocean: Digital timing diagram rendering engine