task:ASCII-SPEC[]

.A Documentation Tool
[def]
--
- [x] Based on Asciidoctor
- [x] With custom Extensions!
--

AsciiSpec is a toolchain based on Asciidoctor with custom modifications for task management, MathML generation, API documentation and more.

1. AsciiSpec Cheat Sheet

Name Source

Inline Task Macro

task:taskId[]

Inline BibTeX Macro

cite:[ref,ref2(optionalPage)]

bibliography::[]

Inline Cwiki Macro

cwiki:path[title=Hyperlinked Text]

cwiki:pageID[title=Hyperlinked Text]

Definition Block

.title
[def]
--
My Definition
--

Requirements Block

.This is the title
[req,id=RSL-3,version=1]
--
My Super Requirement
--

Extended Include

include::{find}myfile.adoc[]

Inline Source Link

srclnk:[DataList#<sizes]

Inline Math

math:E=mc^2[]
$C=2 \Pi r$

Math Block

[math]
++++
\sum_{i=1}^n i = {n(n+1)\over{2}}
++++

2. Userguide

For a general overview of how to use AsciiSpec, the Userguide covers the basics, including;

  • Converting Documents on the Command Line

  • Vanilla Asciidoc Syntax

  • Writing tips and hints

3. Specification

For complete documentation of custom processors, please refer to the Specification.