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

Why doesn't GitHub preserve line breaks in AsciiDoc?

I've stumbled upon an issue where GitHub refuses to preserve the line breaks in code blocks within AsciiDoc readme files or wiki pages. Googling the problem produced a bug on the GitHub tracker, which marks the issue as resolved without a good…
dkobozev
  • 2,265
  • 2
  • 21
  • 21
2
votes
1 answer

How can I insert an unordered list inside a note in Asciidoc without losing the note?

How to add an unordered list inside a note in Asciidoc? I tried the following syntax but the Note disappears and the unordered list appears without being enclosed in a note. Is there a workaround to insert a list into a note? The syntax I tried…
Induja
  • 19
  • 3
2
votes
1 answer

How to convert AsciiDoc to Perl POD?

How to convert manpage written in AsciiDoc lightweight markup language automatically into Perl's POD (Plain Old Documentation)? Perhaps something that converts from DocBook to POD (the conversion from AsciiDoc sources to manpage format i.e. troff…
Jakub Narębski
  • 309,089
  • 65
  • 217
  • 230
2
votes
1 answer

Adding extra information in Spring Rest-Docs using Attributes failing

I'm generating documentation for APIs that are written in Python. I am using Spring Rest-Docs for this which works flawless. Now I must add a list of roles that are authorized to call the API to each API's documentation. What I want to do, is list…
Arc-E-Tect
  • 103
  • 1
  • 10
2
votes
1 answer

How to continue a list item after a sublist

I would like to have some descriptive text in a list item after a sublist. How to achieve that in Asciidoc? Here is the structure I would like to have: A list item of the main list Then a sublist with some list item Just another sublist item to…
Tobias
  • 5,038
  • 1
  • 18
  • 39
2
votes
1 answer

In ASCIIDOC, Is there a variable to access the current section number?

What I am trying to do: == Section === Subsection .Note {section}.{subsection}.{note counter} [NOTE] ... Is this possible automatically?
Paul Wellner Bou
  • 532
  • 5
  • 16
2
votes
1 answer

How can I change text colour mid word in asciidoc syntax?

I have the task of converting some documents to asciidoc format. I have ONLY the asciidoc standard tools - I do NOT have access to any of the css sheets that asciidoctor uses to render my output. I have a need to change colour of a word mid…
rednectar
  • 101
  • 2
  • 12
2
votes
0 answers

Hugo. Is there a way to generate a valid URL from asciidoc link:file.adoc[title]

I have a hugo project structure like this: content/ _index.md a.adoc b.adoc There is a cross-reference to the a.doc in b.adoc link:a.adoc[The page "a"] Hugo renders the link to the URL like this: http://my-site.com/a.doc But this page…
panov.st
  • 21
  • 3
2
votes
2 answers

Best way to generate Mastering the Lightning Network PDF from ASCIIDOC

The Book "Mastering the Lightning Network" is accessible through Github (https://github.com/lnbook/lnbook) and there are multiple asciidoc files that make the book. The License is that it is free for the own use to generate a pdf. So I looked a bit…
Klaus
  • 315
  • 1
  • 10
2
votes
3 answers

Python: Convert HTML to AsciiDoc

I am looking for a Python tool to convert html into AsciiDoc markup. Thanks!
neolaser
  • 6,722
  • 18
  • 57
  • 90
2
votes
2 answers

How to preview asciidoc in vscode with a file with a yaml extension

I have a file which contains YAML at the top and asciidoc at the bottom. The yaml is surrounded by two lines of ---. The file extension is yaml which is required by the application where it's used. The only way i know to get a preview out of vscode…
ridilculous
  • 624
  • 3
  • 16
2
votes
2 answers

Is it possible to use a constant declared in the source code inside an Asciidoc?

I have an Ascii doc reporting several times a sentence like: You can reach the service at https://server:8081/... The problem I have is that the 8081 may be variable, and depends on a constant which is defined somewhere in the code: public static…
Matteo NNZ
  • 11,930
  • 12
  • 52
  • 89
2
votes
1 answer

Generate ascii documentation from openapi 3.0 with samples

I'm using quarkus and openapi-generator-maven-plugin to generate ascii documentation from openapi 3.0 yaml file, but I'm not being able to add the example sample code to request/response. I have the mustache template but I'm not being able to…
Lino
  • 295
  • 1
  • 5
  • 19
2
votes
1 answer

How to add a blank caption for a figure in AsciiDoc

I have an AsciiDoc page which has a number of images. I am converting this into html via antora. On my AsciiDoc page, some of the images have a caption and some do not. For the images with a caption, the first one is named "Figure 1. Some…
didjek
  • 393
  • 5
  • 16
2
votes
1 answer

How to collapse TOC(table of contents) in spring RestDoc (asciidoc)?

I had used SpringRestDoc and want to collapse Table of Contents. Below my index.adoc = Service Rest Docs API Document :doctype: book :icons: font :source-highlighter: highlightjs :toc2: left :theme: flatly :toclevels:…
bbuljj
  • 93
  • 6
1 2 3
…
31 32