Questions tagged [asciidoc]

AsciiDoc is a lightweight markup format similar to Markdown, but it was designed for technical writing with programmatic capabilities as well as semantic structure.

AsciiDoc is a document format for writing technical articles, books, ebooks, slideshows, web pages, man pages, and blogs. AsciiDoc files can be rendered in many formats including HTML, PDF, EPUB, and man page.

AsciiDoc is highly configurable: both the AsciiDoc source file syntax and the backend output markups (handled by templates) can be customized and extended by the user. The format is very similar to the popular Markdown markup, but AsciiDoc additionally incorporates programmatic capabilities and semantic structure. Functionality such as variable substitution, conditional flow, and file inclusion make AsciiDoc dynamic, more like coding. Semantic elements like admonitions, examples, definition lists, and sidebars enable structured writing like a mature technical-writing format.

Originally designed as a lighter, writer-friendlier version of the XML-based DocBook format, AsciiDoc is supported by two distinct toolchain families: the original, Python-sourced variant, as well as newer, Ruby-based tools from an organization called Asciidoctor. The newer suite honors the original syntax almost completely but remains active extending the language and its tooling.

AsciiDoc is free software. The Python-sourced edition is licensed under the terms of the GNU General Public License version 2 (GPLv2). The Ruby-sourced edition is licensed under The MIT License.

471 questions
0
votes
1 answer

Awestruct: Time.now.strftime('%a %-d %B %Y') in asciidoc file

When I have this code in an *.adoc file in awestruct: This website was generated on {localdatetime}. I get: This website was generated on 2015-11-30 11:01:50 CET. But I want it nicely formatted like this: This website was generated on Fri 11…
Geoffrey De Smet
  • 26,223
  • 11
  • 73
  • 120
0
votes
0 answers

No little images for TIP, NOTE nor IMPORTANT

I use https://github.com/asciidoctor/asciidoctor-epub3 to export to kf8 for Kindle. The result looks beautiful but is misses the little images next to TIP, NOTE and IMPORTANT. I guess the files are missing or there is an error in the CSS. How can I…
wintermeyer
  • 8,178
  • 8
  • 39
  • 85
0
votes
1 answer

Render different asciidoc files on same webpage

I have a lot of .asciidoc files (~50). Basically, I want to create a website that can show the content of all these files on the webpage. Till now, everything that I found basically converts the .asciidoc file into an individual .html file. This…
0
votes
1 answer

How is it possible to run swagger2markup from .sh script?

Is there any way to start the asciidoc(or other doctype)-generation from .json files using swagger2markup in a .sh-file? I know it is easily possible (look there) to create a Java class with swagger2markup that has this function, but I want to run…
Coder55
  • 559
  • 5
  • 17
0
votes
1 answer

has asciidoc preprocessor macros

Hey exist in asciidoc a way to create preprocessor macros? The macros in asciidoc allow me generate custom commands for the different output formats. My goal is the creation of valid asciidoc. for example: preprocessormacro: #define pair() %1 and …
aiq
  • 51
  • 4
0
votes
0 answers

How to display AsciiDoc in RoR view with AsciiDoctor Gem?

In my rails view I use <%= Asciidoctor.render '*This* is http://asciidoc.org[AsciiDoc]!' %> I expected to get

This is AsciiDoc!

but instead of that I get…
0
votes
1 answer

asciidoctor breaks rendering deck.js backend

I am attempting to use the deck.js backend with asciidoctor. I followed the instructions at http://asciidoctor.org/docs/install-and-use-deckjs-backend/. I get the following error: $ asciidoctor --trace -T asciidoctor-backends/haml…
Bill Turner
  • 869
  • 1
  • 13
  • 27
0
votes
2 answers

Set AsciiDoc output directory

I want to output the final result into a specific directory. I have already check the command's help with no luck. I also have searched the Internet, but also with no luck. how do I achieve this? edit: It seems that I overlooked the -o option...
shackra
  • 277
  • 3
  • 16
  • 56
0
votes
1 answer

How to get list of figures in Asciidoc

I am using asciid for an article. In the end of my document I want to have a list of figures. How to I create a list of figures? Did not find something useful in the documentation for me.
0
votes
0 answers

Render .adoc file in HTML template using asciidoctor

My goal is to use asciidoctor to render an html file, including an html template, and an .adoc file that can be easily edited by a non-technical worker. I can currently get the html template to render, but am not sure how I can wire up an adoc file…
Arik
  • 31
  • 3
0
votes
2 answers

Compile asciidoc with latexmath equations

I am trying to compile asciidoc document which contains some equations, the format is usually the following: .First equation [latexmath] ++++++++++++++++++++++++++++++++++++++++++++ \[C = \alpha + \beta Y^{\gamma} +…
Aleksei Petrenko
  • 6,698
  • 10
  • 53
  • 87
0
votes
1 answer

Asciidoctor.renderFile with additional options

I'm using asciidoc with a guard file descibed here. Given the asciidoctor options: asciidoctor -a icons -a iconsdir /foo -a copycss bar.adoc I want to add those options to the guard file. But I don't know how. The guard file currently looks…
matcauthon
  • 2,261
  • 1
  • 24
  • 41
0
votes
1 answer

Asciidoctor.js Live Preview on Google Chrome

I'm trying to use Asciidoctor.js Live Preview on Google Chrome, but isntead of my doc i see Error TypeError : Cannot read property 'join' of null It also raises an JS error: Denying load of…
johnatann
  • 145
  • 11
0
votes
1 answer

Automatic, table-formatted, revision history for AsciiDoc document

This block of AsciiDoc will create a title and current revision information: Writing Documentation using AsciiDoc ==================================== v2.0, February 2003: Rewritten for version 2 release. The docinfo_generator will extract this…
craig
  • 25,664
  • 27
  • 119
  • 205
0
votes
2 answers

asciidoc fails when called via python subprocess

Here is my code: #!/usr/bin/python import subprocess asciidoc_file_name = '/tmp/redoc_2013-06-25_12:52:19.txt' asciidoc_call = ["asciidoc","-b docbook45",asciidoc_file_name] print asciidoc_call …
Isaac
  • 810
  • 2
  • 13
  • 31
1 2 3
31
32