AsciiDoc
AsciiDoc
[http://www.methods.co.nz/asciidoc/]
is a simple and powerful method of documentation. It converts ASCII text file into HTML or docbook documents.
The asciidoc program is the implementation of AsciiDoc in Python. A Ruby implementation is the asciidoctor
[http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/]
program. For conversion of text documents the Haskell implementation Pandoc
[https://pandoc.org/]
supports AsciiDoc and many more.
# This command generates the HTML version of the current page asciidoc -adata-uri -aicondir=$PWD AsciiDoc.asciidoc
Tables
Table with a title, three columns, a header, and two rows. .Table Title
|=== |Name of Column 1 |Name of Column 2 |Name of Column 3 |Cell in column 1, row 1 |Cell in column 2, row 1 |Cell in column 3, row 1 |Cell in column 1, row 2 |Cell in column 2, row 2 |Cell in column 3, row 2 |===
Source code formatting
AsciiDoc has built-in filters
[http://www.methods.co.nz/asciidoc/userguide.html#_built_in_filters]
for music, source, latex and graphviz.
System Macros
System Macros
[http://www.methods.co.nz/asciidoc/userguide.html#_system_macros]
are commands for the asciidoc process.
Include directive
In AsciiDoc documents can be nested in other documents. This is how AsciiDoc includes the Home page for example.
include::{sourcedir}/wiki/Wiki.asciidoc[]
:http: https://github.com/furrymcgee :web: https://furrymcgee.github.io :file: https://raw.githubusercontent.com/wiki/furrymcgee/furrymcgee.github.io ///// == Welcome to the wiki! This is the wiki for all projects of furrymcgee on GitHub. footnote:[{http}]. The Wiki is written in AsciiDoc footnote:[http://asciidoc.org/index.html] and markdown footnote:[https://github.github.com/gfm/]. This is the only project with a wiki. The other projects dont use the wiki feature. The complete source of this wiki is available as git repository. footnote:[{http}/furrymcgee.github.io.wiki.git] Single files can be linked online for example this home page. footnote:[{file}/Wiki.asciidoc] The weppages are browsable in link:{web}[WEB]. This page in link:{http}/Wiki.html[HTML] and link:{file}/Wiki.asciidoc[RAW] and format. == furrymcgee.github.io This repository describes all projects by furrymcgee footnote:[http://github.com/furrymcgee/] on GitHub. It includes the GitHub home page footnote:[https://furrymcgee.github.io/] and the Wiki footnote:[https://github.com/furrymcgee/furrymcgee.github.io/wiki/]. It is the only project with a wiki. The other projects dont use the wiki feature. GitHub Pages can be used as Webserver for the HTML output of the Wiki footnote:[https://furrymcgee.github.io/]. There is more information about organization footnote:[https://help.github.com/articles/user-organization-and-project-pages/] and supported languages footnote:[https://raw.githubusercontent.com/github/linguist/master/lib/linguist/languages.yml] on GitHub. ///// .Webpages :http: . //// == Sites The following Websites are hosted on this domain. .Sites [cols="3,5a"] |=== |Git Webserver |link:{http}/cgit[CGit] |TYPO3 Demo |link:{http}/cms[TYPO3] |PHP Composer Repository |link:{http}/satis[Satis] |Haskell Blog |link:{http}/blog[Hakyll] |=== //// == Doxie Search Doxie is a search engine for your office documents and emails on Windows. A typical system has documentation in many formats (docx, pdf, email, ...). The doxie searches all of them a web browser. See also dwww in Debian. - https://github.com/furrymcgee/furrymcgee.github.io/wiki/Doxie == Tools Some ideas about software development tools. .Tools [cols="3,5a"] |=== |High Level Programming Languages |link:{http}/C.html[C], link:{http}/Cpp.html[C++], link:{http}/Java.html[Java], link:{http}/Haskell.html[Haskell] |Command Interpreter |link:{http}/Bash.html[Bash], link:{http}/Perl.html[Perl] |Markup Languages and Text Processors |link:{http}/AsciiDoc.html[AsciiDoc], link:{http}/XML.html[XML], link:{http}/Make.html[PDF] |Databases and Filesystems |link:{http}/SQLite.html[SQLite], link:{http}/Samba.html[Samba] |Operating Systems |link:{http}/GNU.html[GNU], link:{http}/Linux.html[Linux], link:{http}/Debian.html[Debian], link:{http}/Devuan.html[Devuan], link:{http}/SUSE.html[openSUSE], link:{http}/Android.html[Android] |Software Development Tools |link:{http}/Make.html[Make], link:{http}/Git.html[Git], link:{http}/Jenkins.html[Jenkins], link:{http}/Qt.html[Qt], link:{http}/QEMU.html[QEMU] |Web Frontends |link:{http}/Apache.html[Apache], link:{http}/Mojolicious.html[Mojolicious], link:{http}/Typo3.html[Typo3] |===
Attributes
In AsciiDoc attributes
[http://www.methods.co.nz/asciidoc/userguide.html#X18]
are a dictionary of global variables.
Attributes of included documents are valid for the rest of the document.
Lines with invalid attributes are ignored.
:sourcedir: ../.. :asciidoc: http://www.methods.co.nz/asciidoc/userguide.html
Images
asciidoc Wiki.asciidoc wkhtmltoimage Wiki.html Wiki.png convert Wiki.256.png -scale 256 Wiki.png
Makefile
%.html: %.asciidoc asciidoc -adata-uri -aicondir=$PWD $< %.txt: %.html w3m $< > $@ %.png: %.html wkhtmltoimage $< $@ %.256.png: %.png convert $< -scale 256 $@ .PHONY: clean clean: find \( -name '*.html' -o -name '*.png' -o -name '*.txt' \) -delete .DEFAULT_GOAL:=index.html wiki/documentation/AsciiDoc.html: wiki/Wiki.256.png index.html: README.html \ wiki/Wiki.html \ wiki/android/Android.html \ wiki/databases/SQLite.html \ wiki/databases/Samba.html \ wiki/debian/Debian.html \ wiki/debian/Devuan.html \ wiki/debian/GNU.html \ wiki/debian/Linux.html \ wiki/debian/SUSE.html \ wiki/documentation/AsciiDoc.html \ wiki/documentation/Make.html \ wiki/programming/Bash.html \ wiki/programming/C.html \ wiki/programming/Cpp.html \ wiki/programming/Java.html \ wiki/programming/Haskell.html \ wiki/programming/Perl.html \ wiki/programming/Qt.html \ wiki/tools/Git.html \ wiki/tools/Jenkins.html \ wiki/tools/Maven.html \ wiki/qemu/QEMU.html \ wiki/qemu/VirtualXPVHD.html \ wiki/web/Apache.html \ wiki/web/Mojolicious.html \ wiki/web/Typo3.html \ wiki/web/XML.html cp $^ . 2>&- || cp $< index.html
Footnotes
Footnotes
[http://www.methods.co.nz/asciidoc/userguide.html#X92]
reference external documents.
Comments
//// *Comment* block Use: hide comments ////