[yoshimi] Asciidoc

  • From: Ichthyostega <prg@xxxxxxxxxxxxxxx>
  • To: Yoshimi-List <yoshimi@xxxxxxxxxxxxx>
  • Date: Tue, 9 Mar 2021 20:47:38 +0100

Am 09.03.21 um 18:11 schrieb Chris Ahlstrom:

I have used Doxygen (roughly similar to JavaDocs) in the past to generate PDF,
HTML, and even Word (RTF) documents, including pictures, table-of-contents,
index, and, in HTML, a navigable tree structure.  Doxygen markup is a lot
simpler than LaTeX, almost as simple as markdown.

Haven't used DocBooks.

Another very interesting ecosystem in this respect is Ascidoc
https://en.wikipedia.org/wiki/AsciiDoc

In the Lumiera project we use it to generate our whole website,
Basically from plain text files. Asciidoc is not so widely known
and not so popular as markdown, but its main strength is that it
is primarily focussed on document generation, and it supports
lots of features you really need for larger publications.

For one, there is the simple "asciidoc" tool, which is in the
linux repos (its written in python if I recall correct). This
translates asciidoc input into clean structured HTML files,
based on a very simple page template system and CSS.

There are other Asciidoc tools out there, e.g. to transform
the same intput into PDF or into LaTeX. As far as I know,
there is even a transformer to go from ASCIIDOC to Docbook,
which is a widely used standard format for technical documentation.

In the last time, the rather new processor "asciidoctor", written
in Ruby, has gained some popularity. See https://asciidoctor.org/

For the Feature set, you might want to skim through the User Guide
https://asciidoc.org/userguide.html

-- Hermann

Yoshimi source code is available from either: 
https://sourceforge.net/projects/yoshimi
Or: https://github.com/Yoshimi/yoshimi
Our list archive is at: https://www.freelists.org/archive/yoshimi
To post, email to yoshimi@xxxxxxxxxxxxx

Other related posts:

  • » [yoshimi] Asciidoc - Ichthyostega