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
36
votes
4 answers

How do I do strikethrough (line-through) in asciidoc?

How do I render a strikethrough (or line-through) in an adoc file? Let's presume I want to write "That technology is -c-r-a-p- not perfect."
Geoffrey De Smet
  • 26,223
  • 11
  • 73
  • 120
24
votes
5 answers

Is there any way to convert markdown to asciidoc (or be able to produce the same HTML output)?

Here is my problem, normally I convert asciidoc documents to HTML (or more precisely asciidoc --> docbook --> html) but here I've been given a markdown document. I would like to be able to produce an HTML document from that markdown document that…
Laurent T
  • 1,070
  • 4
  • 13
  • 25
21
votes
4 answers

Is it possible to have modular AsciiDoc book (that consists of few files)?

Considering that a book in DocBook format can be done in a "modular" fashion, I hoped I can do similar with AsciiDoc and split chapters and first-level sections in separate files. Unfortunately documentation does not say anything about this. The…
DejanLekic
  • 18,787
  • 4
  • 46
  • 77
20
votes
1 answer

How to prevent images from resetting ordered list numbering in asciidoctor

I am using asciidoctor to generate html. I have the following list: . one . two . three image::mypic.png[] . four And when converted to html, it looks like this: 1. one 2. two 3. three 1. four In html, I would like to see: 1.…
mkfin
  • 507
  • 2
  • 12
18
votes
2 answers

How to resolve keybinding-conflicts in atom.io

I installed the atom.io plugins git-plus and asciidoc-preview. Unfortunately both claim the keybinding Ctrl + Shift + A. There is no warning shown in the keybinding-settings. How to solve this Problem? Should I manually add the *.cson files and add…
Edward
  • 4,453
  • 8
  • 44
  • 82
16
votes
2 answers

How to include a javascript in Asciidoc?

I'm using asciidoctor-maven-plugin to convert .adoc files to html file... Would want to include a link to javascript in the generated html file... Basically would like to see something like below in the html file that is generated from the .adoc…
Karthik
  • 1,383
  • 1
  • 10
  • 11
15
votes
2 answers

Links to sections of same page in asciidoc

I'm writing some text that will be converted to HTML, as a long single page. Can't figure out how to make links to sections as in HTML using #some-id, so that a user when clicking it will go up or down the web page to

Section…

Luis
  • 1,236
  • 5
  • 22
  • 31
13
votes
9 answers

How to convert asciidoc to pdf?

I attempted to convert my mybook.adoc to mybook.pdf using pandoc, and got the following error. $ pandoc -s mybook.adoc -t asciidoc -o mybook.pdf pandoc: cannot produce pdf output with asciidoc writer Is there another tool that I should use instead…
mherzl
  • 5,624
  • 6
  • 34
  • 75
13
votes
2 answers

Can I display asciidoc document in github?

Am I able to display an asciidoc file on github in the same way that I can currently view a markdown file? According to this blog entry, I should be able to do this: If you’re interested in using AsciiDoc, head over to GitHub and create a new file…
krishnab
  • 9,270
  • 12
  • 66
  • 123
13
votes
5 answers

How to add an image to asciidoc book cover page?

I would like to create a pdf book using asciidoc. The title page should include the title, subtitle and an image. So far I could not find any documentation on how to achive this. Intuivly I would do something like My book…
Isaac
  • 810
  • 2
  • 13
  • 31
12
votes
4 answers

Is there any way to change the text size (font size) of specific blocks when you using asciidoc?

I need your help. Now I am using AsciiDoc and AsciiDoctor to create some manuals. I want texts smaller on some specific blocks, for example wide table, wide list, and so on, but not want main texts smaller. Especially I need to make texts of wide…
macoril
  • 147
  • 1
  • 1
  • 8
12
votes
1 answer

Hide header from ToC in Asciidoc / Asciidoctor

I'd like to find a way to hide certain headers from the Table of Contents in my Asciidoc document, which I am processing with Asciidoctor to HTML and PDF. I have increased the headerlevel value to include some other sub-headers, but a side-effect of…
grw
  • 1,279
  • 1
  • 11
  • 19
12
votes
3 answers

How to dynamically hide asciidoc element

I use org.asciidoctor.convert plugin for gradle to generate API documentation for my team. I include files: include::{snippets}/index/curl-request.adoc[] and want to place it's content into spoiler or anything like that. Is there any way to…
cynepnaxa
  • 1,024
  • 1
  • 14
  • 30
12
votes
1 answer

Using an Image as a Link in AsciiDoc

I'm trying to create a "clickable" image in AsciiDoc lightweight markup language with Asciidoctor. I tried the following (not working): image::[[]] For…
CouchDeveloper
  • 18,174
  • 3
  • 45
  • 67
11
votes
2 answers

asciidoc macros

I use asciidoc for rendering text. I have difficulties to understand macros. My goal is to have a simple macro processing (like in LaTeX). I would like to write two Macros: FOO should be replaced by "bar" MYTEXT(xyz) should be replaced by: "This is…
user1165430
  • 121
  • 1
  • 4
1
2 3
…
31 32