diff --git a/doc/asciidoc.reference b/doc/asciidoc.reference index 3a17e2007b..5eb0109859 100644 --- a/doc/asciidoc.reference +++ b/doc/asciidoc.reference @@ -1,56 +1,68 @@ += Single-chapter part of the documentation = + +== Go-to reference chapter for how we use AsciiDoc on this project == + +[NOTE] +====== +This is *not* an attempt for fully self-hosted AsciiDoc document, +consider it a plaintext full of AsciiDoc samples (it's up to the reader +to recognize the borderline) at documentation writers' disposal +to somewhat standardize the style. + See also: http://powerman.name/doc/asciidoc +====== Emphasis: _some test_ Mono: +some text+ Strong: *some text* Super: ^some text^ Sub: ~some text~ Quotes: ``double quoted'' `single quoted' Command: `some-tool --with option` Newly introduced term: 'some text' (another form of emphasis as of this edit) File: mono Literal: mono Tool: command Option: mono Replaceable: emphasis mono Varname: mono Term encountered on system (e.g., menu choice, hostname): strong .Title for Example ===== Some text ===== .Title for Example with XML Listing ===== [source,XML] ----- ----- ===== Naked code listing: (Use 'C' and a leading '#' instead of 'Bash' when commands are being show) [source,C] ----- # some command --here ----- Section anchors: [[s-name]] === Some Section Title === References to section anchors: <> or <>