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
0
votes
2 answers

Convert markdown backticks to asciidoc

I'm switching over from markdown to asciidoc and have a question. In my markdown file, I use backticks to indicate code font (foo.bar()). When this is converted to html, the text gets placed inside code blocks (foo.bar()). How should I format a text…
Shailen Tuli
  • 13,815
  • 5
  • 40
  • 51
0
votes
1 answer

Generate html files using asciidoc in a rails application

I will try to explain my problem : I have a rails application which, for the moment, shows the files which are present in my public directory (there are only txt files). I would like to transform my txt files into html files using asciidoc command…
user2042193
  • 11
-1
votes
1 answer

Can a Java source file also be a valid AsciiDoc document with a table of contents?

I have done some experiments with writing programs that are also at the same time valid documentation that can be rendered as README's by e.g. Github - this ensures that code snippets are up to date and valid - and had some very interesting findings…
Thorbjørn Ravn Andersen
  • 73,784
  • 33
  • 194
  • 347
-1
votes
1 answer

Regex find all word characters not in single-line comment

Fellow coders! I need a way for regex to recognize all \w word characters that are NOT located inside a single-line comment. In my instance, I am using Asciidoc, and single-line comments begin with // at the start of a line. To try to figure it out,…
Jure T
  • 199
  • 1
  • 8
-1
votes
1 answer

asciidoc section titles not working

I have the following asciidoc where I would like to have multiple section titles. = REST API == Token Tokens are used for making authenticated requests to the API. === Getting a token This is how you get a token But it ends up looking something…
secondbreakfast
  • 4,194
  • 5
  • 47
  • 101
-2
votes
1 answer

Is there a way to create MS Word style track changes for two text file versions?

When writing documents it can be important to have a track-changes file available for reviewers. Non-technical reviewers are used to Microsoft Word's track changes feature, where the additions/deletions/modifications are marked up in the working…
markbez
  • 39
  • 5
1 2 3
…
31
32