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

Unordered list in a table cell with Asciidoc

I am trying to have a (simple) unordered list in a table cell in an Asciidoc document. I use asciidoctor. I tried the following: |=== | One | Two | Foo | - Bar - Baz |=== But this results in the last cell having simply the text - Bar - Baz as a…
Florent Georges
  • 2,190
  • 1
  • 15
  • 24
4
votes
1 answer

Shell commands in AsciiDoc

I frequently use blocks of code in my asciidoc. The biggest issue I have is that shell commands beginning with '#' (because they use a root's shell) are rendered as comments in the asciidoc. For example: [source,shell] ---- # firewall-cmd…
Carla
  • 3,064
  • 8
  • 36
  • 65
4
votes
1 answer

Is it possible to use asciidoc with hakyll?

I followed this tutorial to create a basic static web page using hakyll. It includes a number of pages rendered from markdown in the posts directory, e.g. 2015-08-12-spqr.markdown. I prefer asciidoc to markdown, and tried adding an asciidoc…
mherzl
  • 5,624
  • 6
  • 34
  • 75
4
votes
1 answer

How to get bold and italic text in asciidoc mathjax equation?

None of the following approaches produces output that is both bold and italic: :stem: latexmath [latexmath] ++++ \it{\bf{foo}} \textit{\textbf{foo}} \mathit{\mathbf{foo}} ++++ => How can I achieve foo? I use Chrome 67.0.3396.99 with the…
Stefan
  • 10,010
  • 7
  • 61
  • 117
4
votes
2 answers

Placing table of contents not immediately after title page

Using asciidoc, I'd like to place a the table of contents on the third page. At best, I can only manage to place it on page 2; after the title page. My expectation is that something like this should work: = My book A book to enjoy == Preface Enjoy…
chriskelly
  • 7,526
  • 3
  • 32
  • 50
4
votes
2 answers

Asciidoctor images that are links to the image

The following Asciidoc code creates an image (with suitable styling etc) such that if you click on it, you open the image: image:./myimage.jpg[my alt text, role="my css styling", link="./myimage.jpg"] Note the path to the jpg file ./myimage.jpg is…
Jim
  • 229
  • 1
  • 4
4
votes
1 answer

How can I create an Asciidoc table of contents from external files?

The Asciidoc :toc: command creates a nicely formatted table of contents from the headings in the document: :toc: = Part 1 = Part 2 = Part 3 But I want my table of contents to link to other documents, instead of pulling from the document…
Sasgorilla
  • 2,403
  • 2
  • 29
  • 56
4
votes
1 answer

Link to relative files in Asciidoc

I'm writing a document using asciidoc and asciidoctor. So, I'm having a intro.adoc file and then bunch of section files. So, what I want to do is list them on to intro.adoc and add hyperlinks to them so that it will be easy to navigate. For this I…
Ankit R Gadiya
  • 449
  • 1
  • 7
  • 14
4
votes
2 answers

conditional include in asciidoc

I am using Spring RestDoc together with AsciiDoc to describe my rest api. RestDoc generates different files depending if there are request parameters described / response fields etc. I would like to have one template conditionally including whatever…
wrm
  • 1,898
  • 13
  • 24
4
votes
0 answers

Moving artifact from Gitlab CI to project Wiki page

I'm setting up Gitlab CI to create an asciidoc page from a Swagger YAML specification. To this end, I've set up Gitlab to execute the swagger maven plugin and save the results to the public artifacts folder, like this: enter codedeploy:jdk8: stage:…
reinouts
  • 384
  • 3
  • 14
4
votes
2 answers

asciidoc: Including bold inside Code Fence

Ho can I include inside an asciidoc code fence? Here is a sample: [source,js] ---- function doit() { *var thing;* // local variable } ---- The idea is that I would like to highlight certain parts of the code block for teaching…
Manngo
  • 14,066
  • 10
  • 88
  • 110
4
votes
1 answer

How to resemble the PDF-output of AsciidocFX using a Gradle build-script?

I have the following Asciidoc-document: = Test :doctype: article :notitle: :!toc: AsciidocFX shows links in PDFs as footnotes http://stackoverflow.com[SO]. .Asciidoc in PDF does not work in Asciidoctor, but works in…
Edward
  • 4,453
  • 8
  • 44
  • 82
4
votes
2 answers

Unresolved directive error when using the Asciidoctor Maven plugin to publish the API documentation in HTML format

I have success use Spring RestDocs to write a test and generated snippets. When I use the Asciidoctor Maven plugin to publish the API documentation in HTML format, the HTML doc is generated. However, the HTML shows following error. It seems that…
shawn capella
  • 51
  • 1
  • 4
4
votes
1 answer

Asciidoctor attribute replacement in codeblock

In my current Asciidoctor document I have an atribute that I want to use in a codeblock. Is there a way to do String interpolation in a codeblock? Attribute in header.. :api_version: 1.0 Codeblock { "api_version" : "{api_version}", } I seem…
Marco
  • 15,101
  • 33
  • 107
  • 174
4
votes
1 answer

Asciidoc and math equation does not render on .docx

I'm trying to convert .adoc files to .docx Actually I'm using: asciidoctor file.adoc -o file.html pandoc -s -S file.html -o output.docx My math equations or symbols inside .adoc are equal to: latexmath:[$\phi$] and more text as Inline test…
arnaldo
  • 876
  • 8
  • 22
1 2 3
…
31 32