Stack Overflow
Stack Overflow

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
11
votes
1 answer

how to define own asciidoc macro

How do I define a macro in asciidoc/asciidoctor? I will use a repeating pattern in many parts of my document so I would like to make a parametrized substitution to avoid entering the same stuff many times. In particular, I have the following…
igagis
  • 1,959
  • 1
  • 17
  • 27
10
votes
2 answers

How to create external link references in AsciiDoc without repeating the URL multiple times?

In markdown I can write: [example1][myid] [example2][myid] [myid]: http://example.com so I don't have to retype the full external link multiple times. Is there an analogous feature in AsciiDoc? Specially interested in the Asciidoctor…
Ciro Santilli OurBigBook.com
  • 347,512
  • 102
  • 1,199
  • 985
10
votes
1 answer

How to use AsciiDoc with Python?

The original AsciiDoc processor was written in python, but AsciiDoc evolved in the form of Asciidoctor written in Ruby. On my search for how to process modern AsciiDoc (the Asciidoctor dialect), I only came across a post that there is an older…
rdmueller
  • 10,742
  • 10
  • 69
  • 126
10
votes
3 answers

Are there any online demo's of AsciiDoc editors demonstrating live preview?

I have come across many demo's of Markdown editors demonstrating live preview eg: http://daringfireball.net/projects/markdown/dingus http://dillinger.io/ http://www.markitdown.net/markdown http://epiceditor.com/ http://hallojs.org/demo/markdown/ But…
user1063287
  • 10,265
  • 25
  • 122
  • 218
9
votes
2 answers

Literal asterisk in the beginning of the line in asciidoc to html conversion

AsciiDoc source like a * a is converted to HTML as normal text "a * a". If the asterisk is the first non-space character in the line, it starts a list (this is normal). However, I need to start a paragraph with literal asterisk. I tried the…
Andrey
  • 2,503
  • 3
  • 30
  • 39
9
votes
2 answers

How can I make custom class HTML divisions using AsciiDoctor?

I am beginning with AsciiDoctor and I want to output HTML. I've been trying to figure out how to create custom class in divisions, I searched google, manuals etc. and couldn't find a solution. What I want to do is simply write something like…
trabant
  • 105
  • 2
  • 6
8
votes
1 answer

How to pass Maven variable to asciidoctor-maven-plugin?

I have user-guide which uses AsciiDoc it is very beautiful despite that I did not spend much time for it. AsciiDoc plugins are awesome. So I want to pass my Maven final name in the user guide. Question: How to do…
Xelian
  • 16,680
  • 25
  • 99
  • 152
8
votes
1 answer

markdown source code callouts like asciidoctor?

I really like the callouts from asciidoctor, see http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/, and search in page "Code block with callouts", click "view result". But I use Ipython notebook for writing, and Markdown is the choice.…
user3015347
  • 503
  • 3
  • 12
8
votes
3 answers

AsciiDoc add bold text inside a listing block

Have some AsciiDoc that has a block like... ---- this is a test with *some* formatted/tabbed text in it blah ---- ...and I would like the text to display like... this is a test with some formatted/tabbed text in it blah ...where the…
Mark Locklear
  • 5,044
  • 1
  • 51
  • 81
7
votes
1 answer

How can I convert pdf to asciidoc using pandoc?

I am trying to convert pdf book to asciidoc document.I have tried the following command: pandoc -s s.pdf -t asciidoc -o example28.txt I got "Unknown reader" problem. q@q-ABRA-A5-V12-1:~/Downloads$ pandoc -s s.pdf -t asciidoc -o…
my-lord
  • 2,453
  • 3
  • 12
  • 26
7
votes
3 answers

Nesting bullet lists and paragraphs in Asciidoctor

How should I write the Asciidoc(tor) to have the following output: * item 1 * item a paragraph 1 inside item a * item a.1 inside paragraph 1 inside item a paragraph a.1 inside item a.1 * item a.2 inside paragraph 1 inside…
mljrg
  • 4,430
  • 2
  • 36
  • 49
7
votes
1 answer

Converting Asciidoc to LaTeX

I want to convert Asciidoc to LaTeX, then use an existing toolchain that includes LaTeX modules to convert the resulting document further to the final format. Asciidoc's native LaTeX conversion is "experimental" according to their documentation, and…
petersohn
  • 11,292
  • 13
  • 61
  • 98
7
votes
2 answers

Multiple paragraphs in AsciiDoctor table cell

Edit: Since my problem seems to be specific to my setup, I provide a complete minimal working example here. This is my maven setup (pom.xml):
flyx
  • 35,506
  • 7
  • 89
  • 126
7
votes
1 answer

Passing parameters to template files in asciidoc

I'm generating asciidoc snippets using spring rest docs. I can include the generated snippets in my doc page. However, I want to define the structure of each secion once in a seperate adoc file, and have a single line for each of those in my index…
ddouglascarr
  • 1,334
  • 3
  • 14
  • 23
7
votes
1 answer

How reference correctly images through many .adoc files located in different folders

I am working with Atom Editor + the two plugins/packages available about asciidoctor. asciidoc-preview language-asciidoc All work how it is expected. But I am with the following situation: I have the following directory structure: xml figures …
Manuel Jordan
  • 15,253
  • 21
  • 95
  • 158
1
2
3
…
31 32