1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.0.0a2" />
<meta name="description" content="AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page." />
<meta name="keywords" content="AsciiDoc, DocBook, EPUB, PDF, ebooks, slideshow, slidy, man page" />
<title>AsciiDoc Home Page</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
<script type="text/javascript" src="./asciidoc.js"></script>
<script type="text/javascript">
/*<![CDATA[*/
asciidoc.install(1);
/*]]>*/
</script>
</head>
<body style="max-width:70em">
<div id="layout-menu-box">
<div id="layout-menu">
<div>»<a href="index.html">Home</a></div>
<div>»<a href="userguide.html">User Guide</a></div>
<div>»<a href="INSTALL.html">Installation</a></div>
<div>»<a href="faq.html">FAQ</a></div>
<div>»<a href="manpage.html">asciidoc(1)</a></div>
<div>»<a href="a2x.1.html">a2x(1)</a></div>
<div>»<a href="asciidocapi.html">API</a></div>
<div>»<a href="plugins.html">Plugins</a></div>
<div>»<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
<div>»<a href="testasciidoc.html">Tests</a></div>
<div>»<a href="CHANGELOG.html">ChangeLog</a></div>
<div>»<a href="support.html">Support</a></div>
<div id="page-source">»<a href="index.txt">Page Source</a></div>
</div>
</div>
<div id="layout-content-box">
<div id="layout-banner">
<div id="layout-title">AsciiDoc</div>
<div id="layout-description">Text based document generation</div>
</div>
<div id="layout-content">
<div id="header">
<h1>AsciiDoc Home Page</h1>
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="sidebarblock">
<div class="content">
<div class="title">24 January 2021: AsciiDoc 9.0.5 Released</div>
<div class="paragraph"><p>Read the <a href="CHANGELOG.html">CHANGELOG</a> for release highlights and a
full list of all additions, changes and bug fixes. Changes are
documented in the updated <a href="userguide.html">User Guide</a>. See the
<a href="INSTALL.html">Installation page</a> for downloads and and
installation instructions.</p></div>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_introduction">Introduction</h2>
<div class="sectionbody">
<div class="paragraph"><p>AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs. AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page.</p></div>
<div class="paragraph"><p>AsciiDoc is highly configurable: both the AsciiDoc source file syntax
and the backend output markups (which can be almost any type of
SGML/XML markup) can be customized and extended by the user.</p></div>
<div class="paragraph"><p>AsciiDoc is free software and is licensed under the terms of the <em>GNU
General Public License version 2</em> (GPLv2).</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/tip.png" alt="Tip" />
</td>
<td class="content">The pages you are reading were written using AsciiDoc, to view
the corresponding AsciiDoc source click on the <strong>Page Source</strong> menu item
in the left hand margin.</td>
</tr></table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_overview_and_examples">Overview and Examples</h2>
<div class="sectionbody">
<div class="paragraph"><p>You write an AsciiDoc document the same way you would write a
normal text document, there are no markup tags or weird format
notations. AsciiDoc files are designed to be viewed, edited and
printed directly or translated to other presentation formats using
the <code>asciidoc(1)</code> command.</p></div>
<div class="paragraph"><p>The <code>asciidoc(1)</code> command translates AsciiDoc files to HTML, XHTML and
DocBook markups. DocBook can be post-processed to presentation
formats such as HTML, PDF, EPUB, DVI, LaTeX, roff, and Postscript
using readily available Open Source tools.</p></div>
<div class="sect2">
<h3 id="_example_articles">Example Articles</h3>
<div class="ulist"><ul>
<li>
<p>
This XHTML version of the
<a href="asciidoc.css-embedded.html">AsciiDoc User Guide</a>
was generated by AsciiDoc from
<a href="asciidoc.txt">this AsciiDoc file</a>.
</p>
</li>
<li>
<p>
Here’s the <a href="asciidoc.html">same document</a> created by first
generating DocBook markup using AsciiDoc and then converting the
DocBook markup to HTML using <em>DocBook XSL Stylesheets</em>.
</p>
</li>
<li>
<p>
The User Guide again, this time a
<a href="chunked/index.html">chunked version</a>.
</p>
</li>
<li>
<p>
AsciiDoc generated this <a href="article-standalone.html">stand-alone
HTML file</a> containing embedded CSS, JavaScript and images from this
<a href="article.txt">AsciiDoc article template</a> with this command:
</p>
<div class="literalblock">
<div class="content">
<pre><code>asciidoc -a data-uri -a icons -a toc -a max-width=55em article.txt</code></pre>
</div></div>
</li>
<li>
<p>
The same <a href="article.txt">AsciiDoc article template</a> generated
<a href="article-html5-toc2.html">this HTML 5</a> (the <em>toc2</em> attribute puts
a table of contents in the left margin) from this command:
</p>
<div class="literalblock">
<div class="content">
<pre><code>asciidoc -b html5 -a icons -a toc2 -a theme=flask article.txt</code></pre>
</div></div>
</li>
<li>
<p>
The same <a href="article.txt">AsciiDoc article template</a> produced
this <a href="article.html">HTML file</a> and this
<a href="article.pdf">PDF file</a> via DocBook markup generated by AsciiDoc.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="X7">Example Books</h3>
<div class="paragraph"><p>AsciiDoc markup supports all the standard DocBook frontmatter and
backmatter sections (dedication, preface, bibliography, glossary,
index, colophon) plus footnotes and index entries.</p></div>
<div class="ulist"><ul>
<li>
<p>
This <a href="book.txt">AsciiDoc book</a> produced <a href="book.html">this HTML
file</a> using the <em>DocBook XSL Stylesheets</em>.
</p>
</li>
<li>
<p>
The <a href="asciidoc.pdf">PDF formatted AsciiDoc User Guide</a> was
generated from <code>asciidoc(1)</code> DocBook output.
</p>
</li>
<li>
<p>
The <a href="asciidoc.epub">EPUB formatted AsciiDoc User Guide</a> was
generated using <a href="a2x.1.html">a2x</a>.
</p>
</li>
<li>
<p>
This <a href="book.epub">EPUB formatted book skeleton</a> was generated
using <a href="a2x.1.html">a2x</a>.
</p>
</li>
<li>
<p>
This <a href="book-multi.txt">multi-part AsciiDoc book</a> produced
<a href="book-multi.html">this HTML file</a> using the <em>DocBook XSL
Stylesheets</em>.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_example_unix_man_pages">Example UNIX Man Pages</h3>
<div class="paragraph"><p>HTML formatted AsciiDoc man pages
<a href="asciidoc.1.css-embedded.html">with stylesheets</a> and
<a href="asciidoc.1.html">without stylesheets</a> were generated by AsciiDoc
from <a href="asciidoc.1.txt">this file</a>.</p></div>
<div class="paragraph"><p>This <a href="asciidoc.1">roff formatted man page</a> was generated from
<code>asciidoc(1)</code> DocBook output using <code>xsltproc(1)</code> and DocBook XSL
Stylesheets.</p></div>
</div>
<div class="sect2">
<h3 id="X8">Example Slideshows</h3>
<div class="paragraph"><p>The <a href="http://www.w3.org/Talks/Tools/Slidy2/">Slidy</a> backend generates
HTML slideshows that can be viewed in any web browser. What’s nice is
that you can create completely self contained slideshows including
embedded images.</p></div>
<div class="ulist"><ul>
<li>
<p>
Here is the <a href="slidy.html">slidy backend documentation</a> slideshow
and here is it’s <a href="slidy.txt">AsciiDoc source</a>.
</p>
</li>
<li>
<p>
An <a href="slidy-example.html">example slidy slideshow</a> and the
<a href="slidy-example.txt">AsciiDoc source</a>.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_example_web_site">Example Web Site</h3>
<div class="paragraph"><p>The <a href="README-website.html">AsciiDoc website</a> is included in the
AsciiDoc distribution (in <code>./website/</code> and <code>./docs/</code>) as an example website
built using AsciiDoc. See <code>./website/README-website.txt</code>.</p></div>
</div>
<div class="sect2">
<h3 id="_more_examples">More examples</h3>
<div class="ulist"><ul>
<li>
<p>
See below: <a href="#X6"><em>Documents written using AsciiDoc</em></a>.
</p>
</li>
<li>
<p>
Example <a href="newtables.html">Tables</a>.
</p>
</li>
</ul></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_ebook_publication">eBook Publication</h2>
<div class="sectionbody">
<div class="paragraph"><p>The two most popular open eBook formats are
<a href="http://en.wikipedia.org/wiki/EPUB">EPUB</a> and PDF.
The AsciiDoc <a href="a2x.1.html">a2x</a> toolchain wrapper makes it easy to
<a href="publishing-ebooks-with-asciidoc.html">publish EPUB and PDF eBooks
with AsciiDoc</a>. See also <a href="#X7">example books</a> and
<a href="epub-notes.html">AsciiDoc EPUB Notes</a>).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_blogpost_weblog_client">Blogpost weblog client</h2>
<div class="sectionbody">
<div class="paragraph"><p><a href="http://srackham.wordpress.com/blogpost-readme/">blogpost</a> is a
command-line weblog client for publishing AsciiDoc documents to
<a href="http://wordpress.org/">WordPress</a> blog hosts. It creates and updates
weblog posts and pages directly from AsciiDoc source documents.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_source_code_highlighter">Source code highlighter</h2>
<div class="sectionbody">
<div class="paragraph"><p>AsciiDoc includes a <a href="source-highlight-filter.html">source code
highlighter filter</a> that uses
<a href="http://www.gnu.org/software/src-highlite/">GNU source-highlight</a> to
highlight HTML outputs. You also have the option of using the
<a href="http://pygments.org/">Pygments</a> highlighter.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="X3">Mathematical Formulae</h2>
<div class="sectionbody">
<div class="paragraph"><p>You can include mathematical formulae in AsciiDoc XHTML documents using
<a href="asciimathml.html">ASCIIMathML</a> or <a href="latexmathml.html">LaTeXMathML</a>
notation.</p></div>
<div class="paragraph"><p>The <a href="latex-filter.html">AsciiDoc LaTeX filter</a> translates LaTeX
source to an image that is automatically inserted into the AsciiDoc
output documents.</p></div>
<div class="paragraph"><p>AsciiDoc also has <em>latexmath</em> macros for DocBook outputs — they are
documented in <a href="latexmath.pdf">this PDF file</a> and can be used in
AsciiDoc documents processed by <code>dblatex(1)</code>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_editor_support">Editor Support</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
An AsciiDoc syntax highlighter for the Vim text editor is included in Vim.
</p>
<div class="imageblock">
<div class="content">
<a class="image" href="images/highlighter.png">
<img src="images/highlighter.png" alt="images/highlighter.png" height="400" />
</a>
</div>
<div class="title">Syntax highlighter screenshot</div>
</div>
</li>
<li>
<p>
Dag Wieers has implemented an alternative Vim syntax file for
AsciiDoc which can be found here
<a href="https://github.com/dagwieers/asciidoc-vim">https://github.com/dagwieers/asciidoc-vim</a>.
</p>
</li>
<li>
<p>
David Avsajanishvili has written a source highlighter for AsciiDoc
files for <a href="http://projects.gnome.org/gtksourceview/">GtkSourceView</a>
(used by <a href="http://projects.gnome.org/gedit/">gedit</a> and a number of
other applications). The project is hosted here:
<a href="https://launchpad.net/asciidoc-gtk-highlight">https://launchpad.net/asciidoc-gtk-highlight</a>
</p>
</li>
<li>
<p>
AsciiDoc resources for the Emacs editor can be found on the
<a href="http://www.emacswiki.org/emacs/AsciiDoc">AsciiDoc page</a> at the
<a href="http://www.emacswiki.org/emacs/EmacsWiki">Emacs Wiki</a>.
</p>
</li>
<li>
<p>
Christian Zuckschwerdt has written a
<a href="https://github.com/zuckschwerdt/asciidoc.tmbundle">TextMate bundle</a>
for AsciiDoc.
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_try_asciidoc_on_the_web">Try AsciiDoc on the Web</h2>
<div class="sectionbody">
<div class="paragraph"><p>Thaddée Tyl has written an online live editor named
<a href="http://espadrine.github.io/AsciiDocBox/">AsciiDocBox</a> to try AsciiDoc in
your browser.</p></div>
<div class="paragraph"><p>You can use <a href="http://gist.asciidoctor.org/">DocGist</a> to preview AsciiDoc
files hosted on GitHub, Dropbox, and other services. DocGist also
features a real-time collaboration mode.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="X2">External Resources and Applications</h2>
<div class="sectionbody">
<div class="paragraph"><p>Here are resources that I know of, if you know of more drop me a line
and I’ll add them to the list.</p></div>
<div class="ulist"><ul>
<li>
<p>
Check the <a href="INSTALL.html#X2">installation page</a> for packaged versions
of AsciiDoc.
</p>
</li>
<li>
<p>
<a href="http://asciidoctor.org">Asciidoctor</a> provides a modern, compliant, and
substantially faster implementation of the AsciiDoc processor written
in Ruby. This implementation can also be run on the JVM (with
AsciidoctorJ) or using JavaScript (with Asciidoctor.js). The
Asciidoctor project now maintains the official definition of the
AsciiDoc syntax.
</p>
</li>
<li>
<p>
Alex Efros has written an HTML formatted
<a href="http://powerman.name/doc/asciidoc">AsciiDoc Cheatsheet</a> using AsciiDoc.
The Asciidoctor project also provides a comprehensive
<a href="http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/">AsciiDoc
syntax quick reference</a>.
</p>
</li>
<li>
<p>
The <a href="http://www.wikimatrix.org/">WikiMatrix</a> website has an excellent
<a href="https://www.wikimatrix.org/compare/">web page</a> that compares the
various Wiki markup syntaxes. An interesting attempt at Wiki markup
standardization is <a href="http://www.wikicreole.org/">CREOLE</a>.
</p>
</li>
<li>
<p>
The <a href="http://remips.sourceforge.net/">ReMIPS</a> project website has been
built using AsciiDoc.
</p>
</li>
<li>
<p>
Here are some <a href="asciidoc-docbook-xsl.html">DocBook XSL Stylesheets
Notes</a>.
</p>
</li>
<li>
<p>
Karl Mowatt-Wilson has developed an <a href="http://ikiwiki.info/">ikiwiki</a>
plugin for AsciiDoc which he uses to render
<a href="http://mowson.org/karl">his website</a>. The plugin is available
<a href="http://www.mowson.org/karl/colophon/">here</a> and there is some
discussion of the ikiwiki integration
<a href="http://ikiwiki.info/users/KarlMW/discussion/">here</a>.
</p>
</li>
<li>
<p>
Glenn Eychaner has
<a href="http://groups.google.com/group/asciidoc/browse_thread/thread/bf04b55628efe214">reworked
the Asciidoc plugin for ikiwiki</a> that was created by Karl Mowson.
</p>
</li>
<li>
<p>
David Hajage has written an AsciiDoc package for the
<a href="http://www.r-project.org/">R Project</a> (R is a free software
environment for statistical computing). <em>ascii</em> is available on
<em>CRAN</em> (just run <code>install.packages("ascii")</code> from R). Briefly,
<em>ascii</em> replaces R results in AsciiDoc document with AsciiDoc
markup. More information and examples here:
<a href="http://eusebe.github.com/ascii/">http://eusebe.github.com/ascii/</a>.
</p>
</li>
<li>
<p>
Pascal Rapaz has written a Python script to automate AsciiDoc
website generation. You can find it at
<a href="http://www.rapazp.ch/opensource/tools/asciidoc.html">http://www.rapazp.ch/opensource/tools/asciidoc.html</a>.
</p>
</li>
<li>
<p>
Jared Henley has written
<a href="https://jared.henley.id.au/software/awb/">AsciiDoc
Website Builder</a>. <em>AsciiDoc Website Builder</em> (awb) is a Python
program that automates the building of of a website written in
AsciiDoc. All you need to write is the AsciiDoc source plus a few
simple configuration files.
</p>
</li>
<li>
<p>
Filippo Negroni has developed a set of tools to facilitate <em>literate
programming</em> using AsciiDoc. The set of tools is called
<a href="http://eweb.sourceforge.net/">eWEB</a>.
</p>
</li>
<li>
<p>
<a href="https://vanderwijk.info/">Ivo’s blog</a> describes a
<a href="https://ditaa.sourceforge.net/">ditaa</a> filter for AsciiDoc which converts
<a href="https://en.wikipedia.org/wiki/ASCII_art">ASCII art</a> into graphics.
</p>
</li>
<li>
<p>
<a href="https://github.com/gollum/gollum">Gollum</a> is a git-powered wiki, it
supports various formats, including AsciiDoc.
</p>
</li>
<li>
<p>
Gregory Romé has written an
<a href="http://github.com/gpr/redmine_asciidoc_formatter">AsciiDoc plugin</a>
for the <a href="http://www.redmine.org/">Redmine</a> project management
application.
</p>
</li>
<li>
<p>
Paul Hsu has started a
<a href="http://github.com/paulhsu/AsciiDoc.CHT.userguide">Chinese translation
of the AsciiDoc User Guide</a>.
</p>
</li>
<li>
<p>
Dag Wieers has written
<a href="http://dag.wieers.com/home-made/unoconv/">UNOCONV</a>. <em>UNOCONV</em> can
export AsciiDoc outputs to OpenOffice export formats.
</p>
</li>
<li>
<p>
Ed Keith has written
<a href="https://sourceforge.net/projects/codeextactor.berlios/">Code Extractor</a>,
it extracts code snippets from source code files and
inserts them into AsciiDoc documents.
</p>
</li>
<li>
<p>
Ryan Tomayko has written an number of
<a href="https://github.com/rtomayko/adoc-themes">themes for AsciiDoc</a>.
</p>
</li>
<li>
<p>
Lex Trotman has written
<a href="https://github.com/elextr/codiicsa">codiicsa</a>, a program that
converts DocBook to AsciiDoc.
</p>
</li>
<li>
<p>
Qingping Hou has written <a href="http://houqp.github.com/asciidoc-deckjs/">an
AsciiDoc backend for deck.js</a>.
<a href="http://imakewebthings.github.com/deck.js/">deck.js</a> is a JavaScript
library for building modern HTML presentations (slideshows).
</p>
</li>
<li>
<p>
The guys from O’Reilly Media have posted an
<a href="https://github.com/oreillymedia/docbook2asciidoc">XSL Stylesheet to
github</a> that converts DocBook to AsciiDoc.
</p>
</li>
<li>
<p>
Lex Trotman has written
<a href="https://github.com/elextr/flexndex">flexndex</a>, an index generator
tool that be used with AsciiDoc.
</p>
</li>
<li>
<p>
Michael Haberler has created a
<a href="https://code.google.com/p/asciidoc-diag-filter/">blockdiag filter for
Asciidoc</a> which embeds <a href="http://blockdiag.com/">blockdiag</a> images in
AsciiDoc documents.
</p>
</li>
<li>
<p>
Dan Allen has written a
<a href="https://github.com/mojavelinux/asciidoc-bootstrap-docs-backend">Bootstrap
backend</a> for AsciiDoc.
</p>
</li>
<li>
<p>
Steven Boscarine has written
<a href="https://github.com/StevenBoscarine/JavaAsciidocWrapper">Maven wrapper for AsciiDoc</a>.
</p>
</li>
<li>
<p>
Christian Goltz has written
<a href="https://github.com/christiangoltz/shaape">Shaape</a>, an Ascii art to
image converter for AsciiDoc.
</p>
</li>
<li>
<p>
Eduardo Santana has written an
<a href="https://github.com/edusantana/asciidoc-highlight">Asciidoc Highlight
for Notepad++</a>.
</p>
</li>
<li>
<p>
<a href="http://www.geany.org/">Geany</a> 1.23 adds document structure support
for AsciiDoc.
</p>
</li>
</ul></div>
<div class="paragraph"><p>Please let me know if any of these links need updating.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="X6">Documents written using AsciiDoc</h2>
<div class="sectionbody">
<div class="paragraph"><p>Here are some documents I know of, if you know of more drop me a line
and I’ll add them to the list.</p></div>
<div class="ulist"><ul>
<li>
<p>
The book <a href="http://practicalunittesting.com/">Practical Unit Testing</a> by
Tomek Kaczanowski was
<a href="https://groups.google.com/group/asciidoc/browse_frm/thread/4ba13926262efa23">written
using Asciidoc</a>.
</p>
</li>
<li>
<p>
The book <a href="http://oreilly.com/catalog/9781449397296">Programming iOS 4</a>
by Matt Neuburg was written using AsciiDoc. Matt has
<a href="http://www.apeth.net/matt/iosbooktoolchain.html">written an article</a>
describing how he used AsciiDoc and other tools to write the book.
</p>
</li>
<li>
<p>
The book
<a href="http://oreilly.com/catalog/9780596155957/index.html">Programming
Scala</a> by Dean Wampler and Alex Payne (O’Reilly) was
<a href="http://groups.google.com/group/asciidoc/browse_frm/thread/449f1199343f0e27">written
using Asciidoc</a>.
</p>
</li>
<li>
<p>
The Neo4j graph database project uses Asciidoc, and the output is
published here: <a href="http://docs.neo4j.org/">http://docs.neo4j.org/</a>. The build process includes
live tested source code snippets and is described
<a href="http://groups.google.com/group/asciidoc/browse_thread/thread/49d570062fd3ff52">here</a>.
</p>
</li>
<li>
<p>
<a href="http://frugalware.org/">Frugalware Linux</a> uses AsciiDoc for
<a href="http://frugalware.org/docs">documentation</a>.
</p>
</li>
<li>
<p>
<a href="http://www.cherokee-project.com/doc/">Cherokee documentation</a>.
</p>
</li>
<li>
<p>
Henrik Maier produced this professional User manual using AsciiDoc:
<a href="http://www.proconx.com/assets/files/products/modg100/UMMBRG300-1101.pdf">http://www.proconx.com/assets/files/products/modg100/UMMBRG300-1101.pdf</a>
</p>
</li>
<li>
<p>
Henrik also produced this folded single page brochure format
example:
<a href="http://www.proconx.com/assets/files/products/modg100/IGMBRG300-1101-up.pdf">http://www.proconx.com/assets/files/products/modg100/IGMBRG300-1101-up.pdf</a>
</p>
<div class="paragraph"><p>See this
<a href="http://groups.google.com/group/asciidoc/browse_thread/thread/16ab5a06864b934f">AsciiDoc
discussion group thread</a> for details.</p></div>
</li>
<li>
<p>
The
<a href="http://www.kernel.org/pub/software/scm/git/docs/user-manual.html">Git
User’s Manual</a>.
</p>
</li>
<li>
<p>
<em>Git Magic</em><br />
<a href="http://www-cs-students.stanford.edu/~blynn/gitmagic/">http://www-cs-students.stanford.edu/~blynn/gitmagic/</a><br />
<a href="http://github.com/blynn/gitmagic/tree/1e5780f658962f8f9b01638059b27275cfda095c">http://github.com/blynn/gitmagic/tree/1e5780f658962f8f9b01638059b27275cfda095c</a>
</p>
</li>
<li>
<p>
<em>CouchDB: The Definitive Guide</em><br />
<a href="https://docs.couchdb.org/en/stable/">https://docs.couchdb.org/en/stable/</a><br />
<a href="https://groups.google.com/g/asciidoc/c/pg9ny7r4Yqo">https://groups.google.com/g/asciidoc/c/pg9ny7r4Yqo</a>
</p>
</li>
<li>
<p>
<em>Ramaze Manual</em><br />
<a href="http://book.ramaze.net/">http://book.ramaze.net/</a><br />
<a href="http://github.com/manveru/ramaze-book/tree/master">http://github.com/manveru/ramaze-book/tree/master</a>
</p>
</li>
<li>
<p>
The <a href="https://github.com/manveru/KirbyBase">KirbyBase for Ruby</a>
database management system manual.
</p>
</li>
<li>
<p>
The <a href="http://xpt.sourceforge.net/">*Nix Power Tools project</a> uses
AsciiDoc for documentation.
</p>
</li>
<li>
<p>
The <a href="http://www.wesnoth.org/">Battle for Wesnoth</a> project uses
AsciiDoc for its <a href="http://www.wesnoth.org/wiki/WesnothManual">Manual</a>
in a number of different languages.
</p>
</li>
<li>
<p>
Troy Hanson uses AsciiDoc to generate user guides for the
<a href="http://tpl.sourceforge.net/">tpl</a> and
<a href="http://uthash.sourceforge.net/">uthash</a> projects (the HTML versions
have a customised contents sidebar).
</p>
</li>
<li>
<p>
<a href="http://www.weechat.org/">WeeChat</a> uses AsciiDoc for
<a href="http://www.weechat.org/doc">project documentation</a>.
</p>
</li>
<li>
<p>
<a href="https://github.com/Clansuite/Clansuite">Clansuite</a> uses AsciiDoc for
project documentation.
</p>
</li>
<li>
<p>
The <a href="https://github.com/shlomif/fc-solve">Freecell Solver program</a> uses
AsciiDoc for its
<a href="https://fc-solve.shlomifish.org/">distributed documentation</a>.
</p>
</li>
<li>
<p>
Eric Raymond’s <a href="http://gpsd.berlios.de/AIVDM.html">AIVDM/AIVDO
protocol decoding</a> documentation is written using AsciiDoc.
</p>
</li>
<li>
<p>
The <a href="http://www.rowetel.com/ucasterisk/">Free Telephony Project</a>
website is generated using AsciiDoc.
</p>
</li>
<li>
<p>
Warren Block has <a href="http://www.wonkity.com/~wblock/docs/">posted a
number of articles written using AsciiDoc</a>.
</p>
</li>
<li>
<p>
The <a href="https://gitlab.com/ita1024/waf/">Waf project’s</a>
<a href="https://waf.io/book/"><em>Waf Book</em></a> is written using AsciiDoc.
</p>
</li>
<li>
<p>
The <a href="http://www.diffkit.org/">DiffKit</a> project’s documentation and
website have been written using Asciidoc.
</p>
</li>
<li>
<p>
The <a href="http://www.networkupstools.org">Network UPS Tools</a> project
<a href="http://www.networkupstools.org/documentation.html">documentation</a> is
an example of a large documentation project written using AsciiDoc.
</p>
</li>
<li>
<p>
<a href="http://www.archlinux.org/pacman/">Pacman</a>, the
<a href="http://www.archlinux.org/">Arch Linux</a> package manager, has been
documented using AsciiDoc.
</p>
</li>
<li>
<p>
Suraj Kurapati has written a number of customized manuals for his
Open Source projects using AsciiDoc:
</p>
<div class="ulist"><ul>
<li>
<p>
<a href="http://snk.tuxfamily.org/lib/detest/">http://snk.tuxfamily.org/lib/detest/</a>
</p>
</li>
<li>
<p>
<a href="http://snk.tuxfamily.org/lib/ember/">http://snk.tuxfamily.org/lib/ember/</a>
</p>
</li>
<li>
<p>
<a href="http://snk.tuxfamily.org/lib/inochi/">http://snk.tuxfamily.org/lib/inochi/</a>
</p>
</li>
<li>
<p>
<a href="http://snk.tuxfamily.org/lib/rumai/">http://snk.tuxfamily.org/lib/rumai/</a>
</p>
</li>
</ul></div>
</li>
<li>
<p>
The <a href="http://cxxtest.com/">CxxTest</a> project (unit testing for C++
language) has written its User Guide using AsciiDoc.
</p>
</li>
<li>
<p>
The <a href="https://docs.fedoraproject.org/">Fedora Docs</a>
website is generated using AsciiDoc.
</p>
</li>
</ul></div>
<div class="paragraph"><p>Please let me know if any of these links need updating.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="X1">LaTeX Backend</h2>
<div class="sectionbody">
<div class="paragraph"><p>An experimental LaTeX backend was written for AsciiDoc in 2006 by
Benjamin Klum. Benjamin did a superhuman job (I admit it, I didn’t
think this was doable due to AsciiDoc’s SGML/XML bias). Due to
other commitments, Benjamin was unable to maintain this backend.
Here’s <a href="latex-backend.html">Benjamin’s original documentation</a>.
Incompatibilities introduced after AsciiDoc 8.2.7 broke the LaTeX
backend.</p></div>
<div class="paragraph"><p>In 2009 Geoff Eddy stepped up and updated the LaTeX backend, thanks to
Geoff’s efforts it now works with AsciiDoc 8.4.3. Geoff’s updated
<code>latex.conf</code> file shipped with AsciiDoc version 8.4.4. The backend
still has limitations and remains experimental (see
<a href="latex-bugs.html">Geoff’s notes</a>).</p></div>
<div class="paragraph"><p>It’s probably also worth pointing out that LaTeX output can be
generated by passing AsciiDoc generated DocBook through <code>dblatex(1)</code>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_patches_and_bug_reports">Patches and bug reports</h2>
<div class="sectionbody">
<div class="paragraph"><p>Patches and bug reports are are encouraged, but please try to follow
these guidelines:</p></div>
<div class="ulist"><ul>
<li>
<p>
Post bug reports and PRs to the
<a href="https://github.com/asciidoc/asciidoc-py3">asciidoc-py3</a> repository.
</p>
</li>
<li>
<p>
Post questions about using AsciiDoc or AsciiDoc syntax to the
<a href="http://groups.google.com/group/asciidoc">asciidoc discussion list</a>,
this keeps things transparent and gives everyone a chance to
comment.
</p>
</li>
</ul></div>
<div class="sect2">
<h3 id="_bug_reports">Bug reports</h3>
<div class="ulist"><ul>
<li>
<p>
When reporting problems please illustrate the problem with the
smallest possible example that replicates the issue (and please test
your example before posting). This technique will also help to
eliminate red herrings prior to posting.
</p>
</li>
<li>
<p>
Paste the commands that you executed along with any relevant
outputs.
</p>
</li>
<li>
<p>
Include the version of AsciiDoc and the platform you’re running it
on.
</p>
</li>
<li>
<p>
If you can program please consider writing a patch to fix the
problem.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_pull_requests">Pull Requests</h3>
<div class="ulist"><ul>
<li>
<p>
Keep pull requests small and atomic (one issue per PR) — no patch
bombs.
</p>
</li>
<li>
<p>
If possible test your PR against the current master.
</p>
</li>
<li>
<p>
If your PR adds or modifies functionality include a short example
that illustrates the changes.
</p>
</li>
<li>
<p>
Include documentation updates if you’re up to it; otherwise insert
<em>TODO</em> comments at relevant places in the documentation.
</p>
</li>
</ul></div>
</div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version 9.0.5<br />
Last updated 2021-01-30 05:18:13 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
<a href="https://validator.w3.org/check?uri=referer">
<img style="border:0;width:88px;height:31px"
src="https://www.w3.org/Icons/valid-xhtml11-blue"
alt="Valid XHTML 1.1" height="31" width="88" />
</a>
<a href="https://jigsaw.w3.org/css-validator/">
<img style="border:0;width:88px;height:31px"
src="https://jigsaw.w3.org/css-validator/images/vcss-blue"
alt="Valid CSS!" />
</a>
</div>
</div>
</div>
</div>
</body>
</html>
|
