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

Adding an auto-generated number in table row in asciidoc file

Hi so I want to add "auto-generated" row number into a table in asciidoc file. I have something like this. .Sample Table [cols=2, options="header"] |=== |ID | Description |1 |This is row #1 |2 |This is row #2 |=== Where 1 and 2 are hardcoded. Is…
Kyle
  • 406
  • 7
  • 20
3
votes
1 answer

How do I set the table cell widths to minimum

Asciidoc tables use equally sized column width by default. How can I tell asciidoc to use minumum column widths instead? I am able to set relative column widths using [cols="2,1,6,1,2"] However, I want Asciidoc to automatically determine the min…
Stefan
  • 10,010
  • 7
  • 61
  • 117
3
votes
1 answer

Is it possible to use AsciiDoc on VSTS?

I want to use AsciiDoc for documentation purposes and check the documentation into the Git repository next to the code. The AsciiDoc source files I want to be compiled to PDF during build and to be part of the build artifacts. Is there a plugin for…
hot33331
  • 805
  • 11
  • 25
3
votes
1 answer

Asciidoc: how to get page headers & footers?

Is there a correct way to get Asciidoc to include headers and footers? I am trying to work out whether Asciidoc is a serious contender for printed material. I know that it is supposed to be docbook compatible, but I can’t find out how to create…
Manngo
  • 14,066
  • 10
  • 88
  • 110
3
votes
0 answers

AsciiDoc: How can I place graphical hints on an image

I am using AsciiDoc with Asciidoctor Gradle Plugin to generate technical documentation as PDF. When I used M$ Word, I could easily place forms on an image, for example colored rectangles, boxes with numbers or even links to sections within the…
bgerth
  • 1,256
  • 1
  • 12
  • 19
3
votes
2 answers

How can I pass processing square brackets with asciidoc?

Asciidoctor properly renders following line. some text [address[title]] When I add a hard break like this, some text + [address[title]] the second line is not rendered at all. How can I solve this? update So far, I found that one leading space…
Jin Kwon
  • 20,295
  • 14
  • 115
  • 184
3
votes
1 answer

AsciiDoc to html5 external css

I'm trying to convert my AsciiDoc to html5 with the following command : asciidoc -b html5 -a icons -a toc2 -a stylesheet=article.css myPost.adoc It doesn't find my css file cause it look it wrong place : asciidoc: WARNING: myPost.adoc: line 1:…
jaumard
  • 8,202
  • 3
  • 40
  • 63
3
votes
1 answer

How to build a website from ASCIIDoc-files?

Is there an easy way to generate a website with menue,... from ASCIIDoc-files? Let's say I have a couple of ASCII-Doc files: chapter-1.asciidoc chapter-2.asciidoc chapter-3.asciidoc chapter-4.asciidoc I also have a Website Skeleton, that contains…
Edward
  • 4,453
  • 8
  • 44
  • 82
3
votes
2 answers

How to include code excerpts using tags in asciidoc?

I can include the full Greet.java file public class Greet { public static void main(String[] args) { System.out.println("Hello World!"); } } from within the asciidoc file == Hello Java This is how one greets in…
Calaf
  • 10,113
  • 15
  • 57
  • 120
3
votes
3 answers

What are the advantages of using multiple files for an AsciiDoc document?

We are considering using Asciidoc to create a users guide, and we were going to just version a single file on github. We see, however, that established projects like ProGit (https://github.com/progit/progit2/tree/master/book), although also…
Rich Signell
  • 14,842
  • 4
  • 49
  • 77
3
votes
1 answer

create own block styles with template_dir

asciidoctor allows you to provide custom templates through the template_dir option. The documentation seems not to be enough for me to get it going and google is also not of help. Does anybody know of a good example where a custom template is…
rdmueller
  • 10,742
  • 10
  • 69
  • 126
3
votes
1 answer

Is Asciidoc markup programmatically extendable (by existen implementation, like RST)?

reStructuredText allow you extend/rewrite writer for its markup. So you can add new type of embedded objects or introduce new sub-language by defined API. Is this possible with Asciidoc (original Python implementation or Ruby asciidoctor)?
gavenkoa
  • 45,285
  • 19
  • 251
  • 303
3
votes
1 answer

Apostrophe at end (or beginning) of word

How can I get an apostrophe at the beginning or the end of the word? This would be necessary for old-style 'Tis instead of It's Or the apostrophe at the end of a word in plural, like arguments' Of course I could also just…
user1812457
3
votes
1 answer

Publishing toolchain with asciidoc / markdown input, html / pdf output

I saw this related question about publishing toolchain but I know many people did lot of work to produce publishing toolchains recently. One great example I found is this project from akosma. Avdi Grimm shared his work with org-mode in this…
Alper Karapınar
  • 2,694
  • 1
  • 25
  • 36
2
votes
1 answer

How to write callouts using restructured text?

Asciidoc supports callouts. How can one write similar callouts using reStructuredText?
bhadra
  • 12,887
  • 10
  • 54
  • 47
1 2 3
…
31 32