├── .nojekyll ├── .ruby-version ├── CNAME ├── .ruby-gemset ├── images ├── dawn.jpg ├── rev.png ├── toc.png ├── url.png ├── sunset.jpg ├── chunking.jpg ├── doctitle.png ├── epub-text.png ├── mysample.png ├── octocat.jpg ├── opal-logo.png ├── preamble.png ├── rev-long.png ├── toc-left.png ├── toc-level.png ├── toc-macro.png ├── toc-title.png ├── epub-table.png ├── icons │ ├── pause.png │ └── play.png ├── sect0-title.png ├── author-email.png ├── epub-sidebar.png ├── github-history.png ├── multi-author.png ├── mysample-link.png ├── wolpertinger.jpg ├── zen-screenshot.png ├── author-compound.png ├── bower-npm-logos.png ├── custom-pygments.png ├── storm-in-desert.jpg ├── author-email-long.png ├── bountysource-logo.png ├── epub-chapter-title.png ├── mysample-data-uri.png ├── mysample-stylesheet.png ├── toc-sample-github.png ├── sample-ditaa-diagram.png ├── zurb-foundation-yeti.png ├── asciidoclet-screenshot.png ├── chrome-extension-enabled.png ├── epub-chapter-title-day.png ├── epub-figure-admonition.png ├── example-pdf-screenshot.png ├── language-analogy-diagram.png ├── mysample-stylesdir-dir.png ├── sample-graphviz-diagram.png ├── sample-plantuml-diagram.png ├── screenshot-default-theme.png ├── screenshot-print-preview.png ├── asciidoclet-diagram-example.png ├── asciidoctor-diagram-classes.png ├── asciidoctor-diagram-process.png ├── epub-section-title-paragraph.png ├── tiled-editor-and-web-preview.png ├── asciidoctor-growth-2013-to-2015.png ├── epub-correct-text-justification.png ├── syntax-highlight-sample-github.png └── epub-incorrect-text-justification.png ├── .awestruct_ignore ├── .gitignore ├── docs ├── asciidoctor-java.redirect ├── install-and-use-asciidoclet.redirect ├── what-is-asciidoc-why-use-it.redirect ├── asciidoc-writers-guide.pdf ├── asciidoc-quick-reference.redirect ├── install-and-use-asciidoctor-java-integration.redirect ├── _includes │ ├── page-break.adoc │ ├── tracks.csv │ ├── counter.adoc │ ├── biblio.adoc │ ├── dedication.adoc │ ├── toc.adoc │ ├── ex-hr.adoc │ ├── l-list-qa.adoc │ ├── example.adoc │ ├── toc-macro.adoc │ ├── project-lic.adoc │ ├── toc-title.adoc │ ├── ex-comment.adoc │ ├── comment.adoc │ ├── file-output.adoc │ ├── glossary.adoc │ ├── callout-icon.adoc │ ├── ex-counter.adoc │ ├── sum-audio.adoc │ ├── ex-toc.adoc │ ├── structure-intro.adoc │ ├── ex-example.adoc │ ├── ex-video.adoc │ ├── mysample.adoc │ ├── mysample-link.adoc │ ├── ex-verse.adoc │ ├── ex-biblio.adoc │ ├── mysample-stylesheet.adoc │ ├── colophon.adoc │ ├── mysample-stylesdir.adoc │ ├── factory-preview.adoc │ ├── mysample-stylesdir-link.adoc │ ├── image-dir.adoc │ ├── factory-intro.adoc │ ├── ex-header-title.adoc │ ├── ex-open.adoc │ ├── mysample-data-uri.adoc │ ├── preamble-tut.adoc │ ├── sidebar.adoc │ ├── toc-left.adoc │ ├── troubleshoot.adoc │ ├── ex-appendix.adoc │ ├── api-intro.adoc │ ├── toc-level.adoc │ ├── process-intro.adoc │ ├── secure-api.adoc │ ├── relative-include.adoc │ ├── pass-intro.adoc │ ├── project-author.adoc │ ├── subs-group-table.adoc │ ├── ex-sidebar.adoc │ ├── html-ruby-api.adoc │ ├── factory-apply.adoc │ ├── para-lead.adoc │ ├── book-part.adoc │ ├── sum-section.adoc │ ├── ex-ui.adoc │ ├── html-manage-images.adoc │ ├── verse.adoc │ ├── abstract.adoc │ ├── pass-block.adoc │ ├── preamble.adoc │ ├── url-relative.adoc │ ├── callout-xml.adoc │ ├── ex-table-data.adoc │ ├── subs-attr.adoc │ ├── subs-post.adoc │ ├── include-relative-leveloffset.adoc │ ├── para.adoc │ ├── subs-macro.adoc │ ├── sum-toc.adoc │ ├── secure-cli.adoc │ ├── html-code-styles.adoc │ ├── subs-prevent.adoc │ ├── ex-keyword.adoc │ ├── text-bold-italic.adoc │ ├── preface.adoc │ ├── sum-url.adoc │ ├── u-list-nest.adoc │ ├── ex-block.adoc │ ├── output-format.adoc │ ├── float-title.adoc │ ├── sum-video.adoc │ ├── ex-header-attr.adoc │ ├── open.adoc │ ├── section-styles.adoc │ ├── u-list-marker.adoc │ ├── ts-block-render.adoc │ ├── appendix.adoc │ ├── hr.adoc │ ├── exten-post.adoc │ ├── uri-include.adoc │ ├── text-sub-sup.adoc │ ├── ex-callout.adoc │ ├── ex-rev.adoc │ ├── video.adoc │ ├── ex-footnote.adoc │ ├── exten-block.adoc │ ├── footnote.adoc │ ├── element.adoc │ ├── exten-macro.adoc │ ├── attr-element.adoc │ ├── subs-symbol-repl.adoc │ ├── exten-in-macro.adoc │ ├── toc-intro.adoc │ ├── toc-custom.adoc │ ├── xref-relative.adoc │ ├── load-render-api.adoc │ ├── attr-data.adoc │ ├── callout-copy.adoc │ ├── xhtml.adoc │ ├── ex-stem.adoc │ ├── exten-include.adoc │ ├── command-line-usage.adoc │ ├── index.adoc │ ├── indent-include.adoc │ ├── static-front.adoc │ ├── xref.adoc │ ├── subs-specchar.adoc │ ├── static-awe.adoc │ ├── ex-xref.adoc │ ├── image-url.adoc │ ├── ex-o-list.adoc │ ├── para-line-break.adoc │ ├── string-api.adoc │ ├── o-list.adoc │ ├── ex-literal.adoc │ ├── create-theme.adoc │ ├── text-editor.adoc │ ├── html-command-line.adoc │ ├── text-css.adoc │ ├── text.adoc │ ├── quote-alt.adoc │ ├── templates-api.adoc │ ├── doctype.adoc │ ├── exten-intro.adoc │ ├── u-list-check.adoc │ ├── html-styles.adoc │ ├── exten-pre.adoc │ ├── o-list-nest.adoc │ ├── ui.adoc │ ├── header-intro.adoc │ ├── ex-subs.adoc │ ├── listing-wrap.adoc │ ├── manpage.adoc │ ├── ex-listing.adoc │ ├── u-list-complex.adoc │ ├── multi-special-ex.adoc │ ├── subs.adoc │ ├── attr.adoc │ ├── process-multi.adoc │ ├── factory-setup.adoc │ ├── header-title.adoc │ ├── about-asciidoctor.adoc │ ├── block-name-table.adoc │ ├── literal.adoc │ ├── subs-quote.adoc │ ├── ex-include.adoc │ └── meta.adoc ├── asciidoc-syntax-quick-reference.pdf ├── install-and-use-asciidoctor-gradle-plugin.redirect ├── install-and-use-asciidoctor-maven-plugin.redirect ├── character-ref-attributes.adoc ├── asciidoc-article.adoc └── hack-asciidoctor-maven-plugin.adoc ├── _layouts ├── post.html.slim └── press.html.slim ├── fonts ├── fontawesome-webfont.eot ├── fontawesome-webfont.ttf └── fontawesome-webfont.woff ├── robots.txt ├── news ├── asciidoctor-announcement.redirect ├── asciidoctor-maven-plugin-0-1-2-1-released.adoc └── asciidoctor-java-integration-0-1-2-released.adoc ├── stylesheets └── fonts │ └── _default.scss ├── news.html.slim ├── _partials ├── pager.html.slim ├── pagination.html.slim └── entry.html.slim ├── humans.txt ├── .travis.yml ├── javascripts └── view-result.js ├── _ext ├── tagger_patch.rb ├── pipeline.rb ├── awestruct_ext.rb └── sass_functions.rb ├── contributors.html.slim ├── _config ├── docbook-xsl │ └── common-callout-asciidoctor.xsl └── site.yml └── Gemfile /.nojekyll: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.ruby-version: -------------------------------------------------------------------------------- 1 | 2.2 2 | -------------------------------------------------------------------------------- /CNAME: -------------------------------------------------------------------------------- 1 | asciidoctor.org 2 | -------------------------------------------------------------------------------- /.ruby-gemset: -------------------------------------------------------------------------------- 1 | asciidoctor.org 2 | -------------------------------------------------------------------------------- /images/dawn.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/dawn.jpg -------------------------------------------------------------------------------- /images/rev.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/rev.png -------------------------------------------------------------------------------- /images/toc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/toc.png -------------------------------------------------------------------------------- /images/url.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/url.png -------------------------------------------------------------------------------- /.awestruct_ignore: -------------------------------------------------------------------------------- 1 | README.adoc 2 | Gemfile 3 | Gemfile.lock 4 | Rakefile 5 | publish 6 | TODO 7 | -------------------------------------------------------------------------------- /images/sunset.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/sunset.jpg -------------------------------------------------------------------------------- /images/chunking.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/chunking.jpg -------------------------------------------------------------------------------- /images/doctitle.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/doctitle.png -------------------------------------------------------------------------------- /images/epub-text.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/epub-text.png -------------------------------------------------------------------------------- /images/mysample.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/mysample.png -------------------------------------------------------------------------------- /images/octocat.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/octocat.jpg -------------------------------------------------------------------------------- /images/opal-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/opal-logo.png -------------------------------------------------------------------------------- /images/preamble.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/preamble.png -------------------------------------------------------------------------------- /images/rev-long.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/rev-long.png -------------------------------------------------------------------------------- /images/toc-left.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/toc-left.png -------------------------------------------------------------------------------- /images/toc-level.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/toc-level.png -------------------------------------------------------------------------------- /images/toc-macro.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/toc-macro.png -------------------------------------------------------------------------------- /images/toc-title.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/toc-title.png -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /.awestruct/ 2 | /.bundle/ 3 | /.sass-cache/ 4 | /.rbx/ 5 | /_*/ 6 | Gemfile.lock 7 | TODO 8 | -------------------------------------------------------------------------------- /docs/asciidoctor-java.redirect: -------------------------------------------------------------------------------- 1 | --- 2 | interpolate: true 3 | --- 4 | #{site.base_url}/docs/asciidoctorj/ 5 | -------------------------------------------------------------------------------- /images/epub-table.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/epub-table.png -------------------------------------------------------------------------------- /images/icons/pause.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/icons/pause.png -------------------------------------------------------------------------------- /images/icons/play.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/icons/play.png -------------------------------------------------------------------------------- /images/sect0-title.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/sect0-title.png -------------------------------------------------------------------------------- /images/author-email.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/author-email.png -------------------------------------------------------------------------------- /images/epub-sidebar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/epub-sidebar.png -------------------------------------------------------------------------------- /images/github-history.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/github-history.png -------------------------------------------------------------------------------- /images/multi-author.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/multi-author.png -------------------------------------------------------------------------------- /images/mysample-link.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/mysample-link.png -------------------------------------------------------------------------------- /images/wolpertinger.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/wolpertinger.jpg -------------------------------------------------------------------------------- /images/zen-screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/zen-screenshot.png -------------------------------------------------------------------------------- /_layouts/post.html.slim: -------------------------------------------------------------------------------- 1 | --- 2 | layout: base 3 | --- 4 | #content 5 | =partial('entry.html.slim', :post => page) 6 | -------------------------------------------------------------------------------- /docs/install-and-use-asciidoclet.redirect: -------------------------------------------------------------------------------- 1 | --- 2 | interpolate: true 3 | --- 4 | #{site.base_url}/docs/asciidoclet/ 5 | -------------------------------------------------------------------------------- /images/author-compound.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/author-compound.png -------------------------------------------------------------------------------- /images/bower-npm-logos.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/bower-npm-logos.png -------------------------------------------------------------------------------- /images/custom-pygments.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/custom-pygments.png -------------------------------------------------------------------------------- /images/storm-in-desert.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/storm-in-desert.jpg -------------------------------------------------------------------------------- /docs/what-is-asciidoc-why-use-it.redirect: -------------------------------------------------------------------------------- 1 | --- 2 | interpolate: true 3 | --- 4 | #{site.base_url}/docs/what-is-asciidoc/ 5 | -------------------------------------------------------------------------------- /fonts/fontawesome-webfont.eot: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/fonts/fontawesome-webfont.eot -------------------------------------------------------------------------------- /fonts/fontawesome-webfont.ttf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/fonts/fontawesome-webfont.ttf -------------------------------------------------------------------------------- /fonts/fontawesome-webfont.woff: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/fonts/fontawesome-webfont.woff -------------------------------------------------------------------------------- /images/author-email-long.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/author-email-long.png -------------------------------------------------------------------------------- /images/bountysource-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/bountysource-logo.png -------------------------------------------------------------------------------- /images/epub-chapter-title.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/epub-chapter-title.png -------------------------------------------------------------------------------- /images/mysample-data-uri.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/mysample-data-uri.png -------------------------------------------------------------------------------- /images/mysample-stylesheet.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/mysample-stylesheet.png -------------------------------------------------------------------------------- /images/toc-sample-github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/toc-sample-github.png -------------------------------------------------------------------------------- /docs/asciidoc-writers-guide.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/docs/asciidoc-writers-guide.pdf -------------------------------------------------------------------------------- /images/sample-ditaa-diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/sample-ditaa-diagram.png -------------------------------------------------------------------------------- /images/zurb-foundation-yeti.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/zurb-foundation-yeti.png -------------------------------------------------------------------------------- /robots.txt: -------------------------------------------------------------------------------- 1 | # www.robotstxt.org/ 2 | # www.google.com/support/webmasters/bin/answer.py?hl=en&answer=156449 3 | 4 | User-agent: * -------------------------------------------------------------------------------- /images/asciidoclet-screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/asciidoclet-screenshot.png -------------------------------------------------------------------------------- /images/chrome-extension-enabled.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/chrome-extension-enabled.png -------------------------------------------------------------------------------- /images/epub-chapter-title-day.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/epub-chapter-title-day.png -------------------------------------------------------------------------------- /images/epub-figure-admonition.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/epub-figure-admonition.png -------------------------------------------------------------------------------- /images/example-pdf-screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/example-pdf-screenshot.png -------------------------------------------------------------------------------- /images/language-analogy-diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/language-analogy-diagram.png -------------------------------------------------------------------------------- /images/mysample-stylesdir-dir.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/mysample-stylesdir-dir.png -------------------------------------------------------------------------------- /images/sample-graphviz-diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/sample-graphviz-diagram.png -------------------------------------------------------------------------------- /images/sample-plantuml-diagram.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/sample-plantuml-diagram.png -------------------------------------------------------------------------------- /images/screenshot-default-theme.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/screenshot-default-theme.png -------------------------------------------------------------------------------- /images/screenshot-print-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/screenshot-print-preview.png -------------------------------------------------------------------------------- /docs/asciidoc-quick-reference.redirect: -------------------------------------------------------------------------------- 1 | --- 2 | interpolate: true 3 | --- 4 | #{site.base_url}/docs/asciidoc-syntax-quick-reference/ 5 | -------------------------------------------------------------------------------- /docs/install-and-use-asciidoctor-java-integration.redirect: -------------------------------------------------------------------------------- 1 | --- 2 | interpolate: true 3 | --- 4 | #{site.base_url}/docs/asciidoctorj/ 5 | -------------------------------------------------------------------------------- /docs/_includes/page-break.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | User manual 3 | //// 4 | 5 | .Page break syntax 6 | [source] 7 | ---- 8 | <<< 9 | ---- 10 | -------------------------------------------------------------------------------- /docs/asciidoc-syntax-quick-reference.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/docs/asciidoc-syntax-quick-reference.pdf -------------------------------------------------------------------------------- /images/asciidoclet-diagram-example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/asciidoclet-diagram-example.png -------------------------------------------------------------------------------- /images/asciidoctor-diagram-classes.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/asciidoctor-diagram-classes.png -------------------------------------------------------------------------------- /images/asciidoctor-diagram-process.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/asciidoctor-diagram-process.png -------------------------------------------------------------------------------- /images/epub-section-title-paragraph.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/epub-section-title-paragraph.png -------------------------------------------------------------------------------- /images/tiled-editor-and-web-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/tiled-editor-and-web-preview.png -------------------------------------------------------------------------------- /docs/install-and-use-asciidoctor-gradle-plugin.redirect: -------------------------------------------------------------------------------- 1 | --- 2 | interpolate: true 3 | --- 4 | #{site.base_url}/docs/asciidoctor-gradle-plugin/ 5 | -------------------------------------------------------------------------------- /docs/install-and-use-asciidoctor-maven-plugin.redirect: -------------------------------------------------------------------------------- 1 | --- 2 | interpolate: true 3 | --- 4 | #{site.base_url}/docs/asciidoctor-maven-plugin/ 5 | -------------------------------------------------------------------------------- /images/asciidoctor-growth-2013-to-2015.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/asciidoctor-growth-2013-to-2015.png -------------------------------------------------------------------------------- /images/epub-correct-text-justification.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/epub-correct-text-justification.png -------------------------------------------------------------------------------- /images/syntax-highlight-sample-github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/syntax-highlight-sample-github.png -------------------------------------------------------------------------------- /images/epub-incorrect-text-justification.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/orenmazor/asciidoctor.org/master/images/epub-incorrect-text-justification.png -------------------------------------------------------------------------------- /news/asciidoctor-announcement.redirect: -------------------------------------------------------------------------------- 1 | --- 2 | inhibit_indexifier: true 3 | interpolate: true 4 | --- 5 | #{site.base_url}/news/2013/01/30/asciidoc-returns-to-github/ 6 | -------------------------------------------------------------------------------- /docs/_includes/tracks.csv: -------------------------------------------------------------------------------- 1 | Artist,Track,Genre 2 | Baauer,Harlem Shake,Hip Hop 3 | The Lumineers,Ho Hey,Folk Rock 4 | Robyn,Indestructable,Dance 5 | The Piano Guys,Code Name Vivaldi,Classical 6 | -------------------------------------------------------------------------------- /stylesheets/fonts/_default.scss: -------------------------------------------------------------------------------- 1 | @import url(https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic|Noto+Serif:400,400italic,700,700italic|Droid+Sans+Mono:400); 2 | -------------------------------------------------------------------------------- /_layouts/press.html.slim: -------------------------------------------------------------------------------- 1 | --- 2 | layout: base 3 | --- 4 | #header 5 | h1=page.title 6 | span#author=page.author 7 | br 8 | span#revdate=page.date || '2013-01-30' 9 | #content 10 | =content 11 | -------------------------------------------------------------------------------- /docs/_includes/counter.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Counter Attributes 5 | //// 6 | 7 | ---- 8 | include::ex-counter.adoc[tags=base] 9 | ---- 10 | 11 | ==== 12 | include::ex-counter.adoc[tags=base] 13 | ==== 14 | -------------------------------------------------------------------------------- /docs/_includes/biblio.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Bibliography 5 | //// 6 | 7 | .References 8 | ---- 9 | include::ex-biblio.adoc[tags=base] 10 | ---- 11 | 12 | ==== 13 | include::ex-biblio.adoc[tags=base] 14 | ==== 15 | -------------------------------------------------------------------------------- /docs/_includes/dedication.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual 5 | //// 6 | 7 | The dedication page is where the author expresses gratitute toward a person. 8 | 9 | ---- 10 | include::multi-special-ex.adoc[tags=dedicate] 11 | ---- 12 | -------------------------------------------------------------------------------- /docs/_includes/toc.adoc: -------------------------------------------------------------------------------- 1 | = The Dangerous and Thrilling Documentation Chronicles 2 | Kismet Chameleon 3 | :toc: 4 | 5 | This journey begins on a bleary... 6 | 7 | == Cavern Glow 8 | 9 | The river rages through the cavern, rattling its content... 10 | -------------------------------------------------------------------------------- /news.html.slim: -------------------------------------------------------------------------------- 1 | --- 2 | layout: base 3 | --- 4 | #content 5 | - page.posts.each do |post| 6 | - page.stem = '' if post.stem 7 | =partial('entry.html.slim', :post => post, :listing => true) 8 | =partial('pagination.html.slim', :paginator => page.posts) 9 | -------------------------------------------------------------------------------- /docs/_includes/ex-hr.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Horizontal Rule 5 | - quick-ref 6 | //// 7 | 8 | // tag::base[] 9 | ''' 10 | // end::base[] 11 | 12 | // tag::md[] 13 | --- 14 | 15 | - - - 16 | 17 | *** 18 | 19 | * * * 20 | // end::md[] 21 | -------------------------------------------------------------------------------- /docs/_includes/l-list-qa.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Labeled lists: Question and answer style list 5 | //// 6 | 7 | .Q&A 8 | ---- 9 | include::ex-l-list.adoc[tags=qa] 10 | ---- 11 | 12 | ==== 13 | include::ex-l-list.adoc[tags=qa] 14 | ==== 15 | -------------------------------------------------------------------------------- /_partials/pager.html.slim: -------------------------------------------------------------------------------- 1 | .row 2 | ul.pager 3 | li.previous.span1 4 | - if page.post.previous_post 5 | a href=page.post.previous_post.url Previous 6 | li.next.span1.offset7 7 | - if page.post.next_post 8 | a href=page.post.next_post.url Next 9 | -------------------------------------------------------------------------------- /docs/_includes/example.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: example 5 | //// 6 | 7 | .Example syntax 8 | [source] 9 | ---- 10 | include::ex-example.adoc[tags=base] 11 | ---- 12 | 13 | .Result: Example block 14 | -- 15 | include::ex-example.adoc[tags=base] 16 | -- 17 | -------------------------------------------------------------------------------- /docs/_includes/toc-macro.adoc: -------------------------------------------------------------------------------- 1 | = The Dangerous and Thrilling Documentation Chronicles 2 | Kismet Chameleon 3 | :toc: macro // <1> 4 | 5 | This journey begins on a bleary... 6 | 7 | == Cavern Glow 8 | 9 | toc::[] // <2> 10 | 11 | The river rages through the cavern, rattling its content... 12 | -------------------------------------------------------------------------------- /docs/_includes/project-lic.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Copyright and License 5 | //// 6 | 7 | Copyright (C) 2012-2014 Dan Allen and Ryan Waldron. 8 | Free use of this software is granted under the terms of the MIT License. 9 | 10 | See the {license}[LICENSE] file for details. 11 | -------------------------------------------------------------------------------- /docs/_includes/toc-title.adoc: -------------------------------------------------------------------------------- 1 | = The Dangerous and Thrilling Documentation Chronicles 2 | Kismet Chameleon 3 | :toc: // <1> 4 | :toc-title: Table of Adventures // <2> 5 | 6 | This journey begins on a bleary... 7 | 8 | == Cavern Glow 9 | 10 | The river rages through the cavern, rattling its content... 11 | -------------------------------------------------------------------------------- /docs/_includes/ex-comment.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Comments 5 | - quick-ref 6 | //// 7 | 8 | // tag::line[] 9 | // A single-line comment. 10 | // end::line[] 11 | 12 | // tag::bl[] 13 | //// 14 | A multi-line comment. 15 | 16 | Notice it's a delimited block. 17 | //// 18 | // end::bl[] 19 | -------------------------------------------------------------------------------- /docs/_includes/comment.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: comments 5 | //// 6 | 7 | .Line 8 | ---- 9 | include::ex-comment.adoc[tags=line] 10 | ---- 11 | 12 | TIP: Single-line comments can be used to divide elements, such as two adjacent lists. 13 | 14 | .Block 15 | ---- 16 | include::ex-comment.adoc[tags=bl] 17 | ---- 18 | -------------------------------------------------------------------------------- /docs/_includes/file-output.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Specifying an output file 5 | //// 6 | 7 | The `asciidoctor` command writes to the specified output file if the input is `stdin`. 8 | 9 | For example, the following command writes to `output.html` instead of to the console: 10 | 11 | $ echo "content" | asciidoctor -o output.html 12 | -------------------------------------------------------------------------------- /docs/_includes/glossary.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual 5 | //// 6 | 7 | You can include a glossary of definitions by including the `[glossary]` marker before the section header and before the first definition. 8 | 9 | ---- 10 | [glossary] 11 | == Glossary 12 | 13 | [glossary] 14 | mud:: wet, cold dirt 15 | rain:: 16 | water falling from the sky 17 | ---- 18 | -------------------------------------------------------------------------------- /docs/_includes/callout-icon.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: callouts: Callout icons 5 | //// 6 | 7 | The font icons setting also enables callout icons drawn using CSS. 8 | 9 | [source] 10 | ---- 11 | include::ex-callout.adoc[tags=co-icon] 12 | ---- 13 | <1> Activates font-based icons in the HTML5 backend 14 | <2> Admonition block that uses a font-based icon 15 | -------------------------------------------------------------------------------- /docs/_includes/ex-counter.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Counter Attributes 5 | - quick-ref 6 | //// 7 | 8 | // tag::base[] 9 | [caption=""] 10 | .Parts{counter2:index:0} 11 | |=== 12 | |Part Id |Description 13 | 14 | |PX-{counter:index} 15 | |Description of PX-{index} 16 | 17 | |PX-{counter:index} 18 | |Description of PX-{index} 19 | |=== 20 | // end::base[] 21 | -------------------------------------------------------------------------------- /docs/_includes/sum-audio.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Audio: Summary 5 | //// 6 | 7 | .Audio attributes and values 8 | [cols="1m,1,2,2"] 9 | |=== 10 | |Attribute |Value(s) |Example Syntax |Comments 11 | 12 | |options 13 | |`autoplay`, `loop`, `controls`, `nocontrols` 14 | |`audio::ocean_waves.mp3[options="autoplay,loop"]` 15 | |The controls value is enabled by default 16 | |=== 17 | -------------------------------------------------------------------------------- /docs/_includes/ex-toc.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: 5 | - quick-ref 6 | //// 7 | 8 | // tag::base[] 9 | = AsciiDoc Writer's Guide 10 | Doc Writer 11 | v1.0, 2013-08-01 12 | :toc: 13 | // end::base[] 14 | 15 | // tag::pos[] 16 | = AsciiDoc Writer's Guide 17 | Doc Writer 18 | v1.0, 2014-08-01 19 | :toc: right 20 | // end::pos[] 21 | -------------------------------------------------------------------------------- /docs/_includes/structure-intro.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual 5 | //// 6 | 7 | Asciidoctor provides macros or attributes for the specialized frontmatter and backmatter sections commonly found in journal articles, academic papers, and books. 8 | In the following sections, you'll learn the dependency, structure, and output rules for the special section macros and attributes and how to use them. 9 | -------------------------------------------------------------------------------- /docs/_includes/ex-example.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Example 5 | - quick-ref 6 | //// 7 | 8 | // tag::base[] 9 | .Sample document 10 | ==== 11 | Here's a sample AsciiDoc document: 12 | 13 | [listing] 14 | .... 15 | = Title of Document 16 | Doc Writer 17 | :toc: 18 | 19 | This guide provides... 20 | .... 21 | 22 | The document header is useful, but not required. 23 | ==== 24 | // end::base[] 25 | -------------------------------------------------------------------------------- /docs/_includes/ex-video.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Video 5 | - quick-ref 6 | //// 7 | 8 | // tag::base[] 9 | video::video_file.mp4[] 10 | // end::base[] 11 | 12 | // tag::attr[] 13 | video::video_file.mp4[width=640, start=60, end=140, options=autoplay] 14 | // end::attr[] 15 | 16 | // tag::you[] 17 | video::rPQoq7ThGAU[youtube] 18 | // end::you[] 19 | 20 | // tag::vim[] 21 | video::67480300[vimeo] 22 | // end::vim[] 23 | -------------------------------------------------------------------------------- /docs/_includes/mysample.adoc: -------------------------------------------------------------------------------- 1 | = My First Experience with the Dangers of Documentation 2 | 3 | In my world, we don't have to worry about mutant, script-injecting warlocks. 4 | No. 5 | We have something far worse. 6 | We're plagued by Wolpertingers. 7 | 8 | == Origins 9 | 10 | You may not be familiar with these http://en.wikipedia.org/wiki/Wolpertinger[ravenous beasts], but, trust me, they'll eat your shorts and suck the loops from your code. 11 | -------------------------------------------------------------------------------- /docs/_includes/mysample-link.adoc: -------------------------------------------------------------------------------- 1 | = My First Experience with the Dangers of Documentation 2 | :linkcss: 3 | 4 | In my world, we don't have to worry about mutant, script-injecting warlocks. 5 | No. 6 | We have something far worse. 7 | We're plagued by Wolpertingers. 8 | 9 | == Origins 10 | 11 | You may not be familiar with these http://en.wikipedia.org/wiki/Wolpertinger[ravenous beasts], but, trust me, they'll eat your shorts and suck the loops from your code. 12 | -------------------------------------------------------------------------------- /docs/_includes/ex-verse.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Quotes 5 | //// 6 | 7 | // tag::para[] 8 | [verse, Carl Sandburg, two lines from the poem Fog] 9 | The fog comes 10 | on little cat feet. 11 | // end::para[] 12 | 13 | // tag::bl[] 14 | [verse, Carl Sandburg, Fog] 15 | ____ 16 | The fog comes 17 | on little cat feet. 18 | 19 | It sits looking 20 | over harbor and city 21 | on silent haunches 22 | and then moves on. 23 | ____ 24 | // end::bl[] 25 | -------------------------------------------------------------------------------- /docs/_includes/ex-biblio.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Bibliography 5 | - quick-ref 6 | //// 7 | 8 | // tag::base[] 9 | _The Pragmatic Programmer_ <> should be required reading for 10 | all developers. 11 | 12 | [bibliography] 13 | - [[[prag]]] Andy Hunt & Dave Thomas. The Pragmatic Programmer: 14 | From Journeyman to Master. Addison-Wesley. 1999. 15 | - [[[seam]]] Dan Allen. Seam in Action. Manning Publications. 16 | 2008. 17 | // end::base[] 18 | -------------------------------------------------------------------------------- /docs/_includes/mysample-stylesheet.adoc: -------------------------------------------------------------------------------- 1 | = My First Experience with the Dangers of Documentation 2 | :stylesheet: mystyles.css 3 | 4 | In my world, we don't have to worry about mutant, script-injecting warlocks. 5 | No. 6 | We have something far worse. 7 | We're plagued by Wolpertingers. 8 | 9 | == Origins 10 | 11 | You may not be familiar with these http://en.wikipedia.org/wiki/Wolpertinger[ravenous beasts], but, trust me, they'll eat your shorts and suck the loops from your code. 12 | -------------------------------------------------------------------------------- /docs/_includes/colophon.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual 5 | //// 6 | 7 | Book colophons list information such as the ISBN, publishing house, edition and copyright dates, legal notices and disclaimers, cover art, design, and book layout credits, and any significant production notes. 8 | In most mass market books, the colophon is on the verso (back side) of the title page, but it can also be located at the end of the book. 9 | 10 | ---- 11 | include::multi-special-ex.adoc[tags=colophon] 12 | ---- 13 | -------------------------------------------------------------------------------- /docs/_includes/mysample-stylesdir.adoc: -------------------------------------------------------------------------------- 1 | = My First Experience with the Dangers of Documentation 2 | :stylesdir: mystylesheets/ 3 | :stylesheet: mystyles.css 4 | 5 | In my world, we don't have to worry about mutant, script-injecting warlocks. 6 | No. 7 | We have something far worse. 8 | We're plagued by Wolpertingers. 9 | 10 | == Origins 11 | 12 | You may not be familiar with these http://en.wikipedia.org/wiki/Wolpertinger[ravenous beasts], but, trust me, they'll eat your shorts and suck the loops from your code. 13 | -------------------------------------------------------------------------------- /docs/_includes/factory-preview.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Stylesheet Factory: External preview 5 | //// 6 | 7 | You may want to preview sample HTML files on another computer or device. 8 | To do that, you need to serve them through a web server. 9 | You can quickly serve HTML files in the root directory of the project using the following command: 10 | 11 | .Using Python 12 | $ python -m SimpleHTTPServer 4242 13 | 14 | or 15 | 16 | .Using Ruby >= 1.9.3 17 | $ ruby -run -e httpd . -p 4242 18 | -------------------------------------------------------------------------------- /humans.txt: -------------------------------------------------------------------------------- 1 | /* TEAM */ 2 | Chef: Dan Allen 3 | Site: http://mojavelinux.com 4 | Twitter: @mojavelinux 5 | From: Denver, CO 6 | 7 | Web designer: Sarah White 8 | Site: http://graphitefriction.com 9 | Twitter: @carbonfray 10 | From: Denver, CO 11 | 12 | /* SITE */ 13 | Last update: 2013/03/23 14 | Language: English 15 | Standards: HTML5, CSS3 16 | Components: Foundation, Normalize, Modernizr, jQuery, FontAwesome, highlight.js 17 | Software: Ruby (RVM), Awestruct, Asciidoctor (AsciiDoc), Tilt, Slim, Haml, Git, VIM, Rake, Travis CI 18 | -------------------------------------------------------------------------------- /docs/_includes/mysample-stylesdir-link.adoc: -------------------------------------------------------------------------------- 1 | = My First Experience with the Dangers of Documentation 2 | :stylesdir: mystylesheets/ 3 | :stylesheet: mystyles.css 4 | :linkcss: 5 | 6 | In my world, we don't have to worry about mutant, script-injecting warlocks. 7 | No. 8 | We have something far worse. 9 | We're plagued by Wolpertingers. 10 | 11 | == Origins 12 | 13 | You may not be familiar with these http://en.wikipedia.org/wiki/Wolpertinger[ravenous beasts], but, trust me, they'll eat your shorts and suck the loops from your code. 14 | -------------------------------------------------------------------------------- /docs/_includes/image-dir.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: images: Set the images directory 5 | //// 6 | 7 | Images are resolved relative to the value of the `imagesdir` document attribute, which defaults to an empty value. 8 | The imagesdir attribute can be an absolute path, relative path or base URL. 9 | If the image target is a URL or an absolute path, the imagesdir prefix is _not_ added. 10 | 11 | TIP: You should use the imagesdir attribute to avoid hard coding the shared path to your images in every image macro. 12 | -------------------------------------------------------------------------------- /docs/_includes/factory-intro.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Stylesheet Factory 5 | //// 6 | 7 | The {factory-ref}[Asciidoctor stylesheet factory] is where themes are developed for styling your documents. 8 | Specifically, these stylesheets can be used to quickly customize the look and feel of HTML 5 documents generated by Asciidoctor. 9 | 10 | To view the Asciidoctor themes in action, visit the {showcase-ref}[theme showcase]. 11 | 12 | WARNING: The Asciidoctor stylesheet factory is only compatible with Asciidoctor 0.1.2 and greater. 13 | -------------------------------------------------------------------------------- /docs/_includes/ex-header-title.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Example 3 | 4 | Included in: 5 | 6 | - user-manual: Header 7 | - quick-ref 8 | //// 9 | 10 | // tag::base[] 11 | = The Dangerous and Thrilling Documentation Chronicles 12 | 13 | This journey begins on a bleary Monday morning. 14 | // end::base[] 15 | 16 | // tag::b-base[] 17 | = My Document's Title 18 | 19 | My document provides... 20 | // end::b-base[] 21 | 22 | // tag::doc[] 23 | = The Dangerous and Thrilling Documentation Chronicles 24 | 25 | {doctitle} begins on a bleary Monday morning. 26 | // end::doc[] 27 | -------------------------------------------------------------------------------- /docs/_includes/ex-open.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Open Block 5 | - quick-ref 6 | //// 7 | 8 | // tag::base[] 9 | -- 10 | An open block can be an anonymous container, 11 | or it can masquerade as any other block. 12 | -- 13 | // end::base[] 14 | 15 | // tag::src[] 16 | [source] 17 | -- 18 | puts "I'm a source block!" 19 | -- 20 | // end::src[] 21 | 22 | // tag::sb[] 23 | [sidebar] 24 | .Related information 25 | -- 26 | This is aside text. 27 | 28 | It is used to present information related to the main content. 29 | -- 30 | // end::sb[] 31 | -------------------------------------------------------------------------------- /docs/_includes/mysample-data-uri.adoc: -------------------------------------------------------------------------------- 1 | = My First Experience with the Dangers of Documentation 2 | :imagesdir: myimages 3 | :data-uri: 4 | 5 | In my world, we don't have to worry about mutant, script-injecting warlocks. 6 | No. 7 | We have something far worse. 8 | We're plagued by Wolpertingers. 9 | 10 | == Origins 11 | 12 | [.left.text-center] 13 | image::wolpertinger.jpg[Wolpertinger] 14 | 15 | You may not be familiar with these http://en.wikipedia.org/wiki/Wolpertinger[ravenous beasts], but, trust me, they'll eat your shorts and suck the loops from your code. 16 | -------------------------------------------------------------------------------- /docs/_includes/preamble-tut.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Preamble 3 | 4 | Included in: 5 | 6 | - user-manual 7 | //// 8 | 9 | Content between the document header and the first section level title is called the preamble. 10 | A preamble is optional. 11 | 12 | .Preamble 13 | ---- 14 | include::preamble.adoc[] 15 | ---- 16 | 17 | When using the default Asciidoctor stylesheet, the <> is applied to the first paragraph of the preamble. 18 | 19 | .Result: Rendered preamble 20 | ==== 21 | image::preamble.png[Preamble with lead attribute applied] 22 | ==== 23 | -------------------------------------------------------------------------------- /docs/_includes/sidebar.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: sidebar 5 | //// 6 | 7 | Use a sidebar for ancillary content that doesn't fit into the flow of the document's narrative. 8 | A sidebar can be titled and contain any type of content such as source code and images. 9 | 10 | .Sidebar syntax 11 | [source] 12 | ---- 13 | include::ex-sidebar.adoc[tags=base-c] 14 | ---- 15 | <1> A title is optional. 16 | <2> A sidebar is delimited by four asterisks (`****`). 17 | 18 | .Result: Sidebar with title 19 | ==== 20 | include::ex-sidebar.adoc[tags=base] 21 | ==== 22 | -------------------------------------------------------------------------------- /docs/_includes/toc-left.adoc: -------------------------------------------------------------------------------- 1 | = The Dangerous and Thrilling Documentation Chronicles 2 | Kismet Chameleon 3 | :toc: left 4 | 5 | This journey begins on a bleary... 6 | 7 | == Cavern Glow 8 | 9 | The river rages through the cavern, rattling its content... 10 | 11 | == The Ravages of Writing 12 | 13 | Her finger socks had been vaporized by crystalline nuggets of... 14 | 15 | === A Recipe for Potion 16 | 17 | Two fresh Burdockian leaves, harvested by the light of the teal moons... 18 | 19 | ==== Searching for Burdockian 20 | 21 | Crawling through the twisted understory... 22 | -------------------------------------------------------------------------------- /docs/_includes/troubleshoot.adoc: -------------------------------------------------------------------------------- 1 | = Troubleshooting 2 | :author: Sarah White 3 | :email: 4 | :description: Tips for fixing installation, syntax, processing, and rendering problems when using Asciidoctor. 5 | :keywords: Asciidoctor, AsciiDoc, syntax, render, process, problem, issue, tips 6 | 7 | //// 8 | Included in: 9 | 10 | - user-manual: Troubleshooting 11 | - faq: Troubleshooting 12 | //// 13 | 14 | // tag::faq[] 15 | [qanda] 16 | include::ts-block-render.adoc[] 17 | include::ts-url-format.adoc[] 18 | // end::faq[] 19 | -------------------------------------------------------------------------------- /docs/_includes/ex-appendix.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Appendix 5 | //// 6 | 7 | // tag::app[] 8 | :appendix-caption: App 9 | :numbered: 10 | 11 | == Title 12 | 13 | === Subsection 14 | 15 | [appendix] 16 | == First Appendix 17 | 18 | === First subsection 19 | 20 | === Second subsection 21 | 22 | [appendix] 23 | == Second Appendix 24 | // end::app[] 25 | 26 | // tag::app-out[] 27 | 1. Title 28 | 1.1. Subsection 29 | 30 | App A: First Appendix 31 | A.1. First subsection 32 | A.2. Second subsection 33 | 34 | App B: Second Appendix 35 | // end::app-out[] 36 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: ruby 2 | rvm: 3 | # - 1.9.3 4 | - 2.0.0 5 | env: 6 | global: 7 | # created using `travis encrypt -r asciidoctor/asciidoctor.org` 8 | # GIT_N= GIT_E= GH_U= GH_T= 9 | - secure: NQpd6Bebz/A4a3WytjT4+LMjbSwxozsTYsIl9B+1sM8csHJCJSCl84wx8/ro03fumQfPtxFNqJXJ+d3x3m/qKwNT2/O/ym3ZmF2eouUA6JLt+15HZVwtzRu58+x2zCDv+eIjdNdyaP+oATJMrJfqpY+ngawfsnD+NLZnGv0qM/Q= 10 | # speeds up Nokogiri installation 11 | - NOKOGIRI_USE_SYSTEM_LIBRARIES=true 12 | branches: 13 | only: 14 | - master 15 | script: rake travis 16 | -------------------------------------------------------------------------------- /docs/_includes/api-intro.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | API introduction for Asciidoctor 3 | This file is included in the user-manual documents 4 | //// 5 | 6 | In addition to the command line interface, Asciidoctor provides a Ruby API. 7 | The API is intended for integration with other software projects and is suitable for server-side applications, such as Rails, Sinatra and GitHub. 8 | 9 | TIP: Asciidoctor also has a Java API that mirrors the Ruby API. 10 | The Java API calls through to the Ruby API using an embedded JRuby runtime. 11 | See the {java}[Asciidoctor Java integration project] for more information. 12 | -------------------------------------------------------------------------------- /docs/_includes/toc-level.adoc: -------------------------------------------------------------------------------- 1 | = The Dangerous and Thrilling Documentation Chronicles 2 | Kismet Chameleon 3 | :toc: // <1> 4 | :toclevels: 4 // <2> 5 | 6 | This journey begins on a bleary... 7 | 8 | == Cavern Glow 9 | 10 | The river rages through the cavern, rattling its content... 11 | 12 | == The Ravages of Writing 13 | 14 | Her finger socks had been vaporized by crystalline nuggets of... 15 | 16 | === A Recipe for Potion 17 | 18 | Two fresh Burdockian leaves, harvested by the light of the teal moons... 19 | 20 | ==== Searching for Burdockian 21 | 22 | Crawling through the twisted understory... 23 | -------------------------------------------------------------------------------- /docs/_includes/process-intro.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Processing your document 3 | Introduction 4 | 5 | This document is included in: 6 | 7 | - render-documents 8 | - user-manual 9 | //// 10 | 11 | While the AsciiDoc syntax is designed to be readable in raw form, the intended audience for that format are writers and editors. 12 | Readers aren't going to appreciate the raw text nearly as much. 13 | Aesthetics matter. 14 | You'll want to apply nice typography with font sizes that adhere to the golden ratio, colors, icons and images to give it the respect it deserves. 15 | That's where the Asciidoctor themes and backends come into play. 16 | -------------------------------------------------------------------------------- /docs/_includes/secure-api.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Running Asciidoctor Securely: Set the safe mode in the API 5 | //// 6 | 7 | The default safe level in the API is +SECURE+. 8 | 9 | In the API, you can set the safe mode using a string, symbol or integer value. 10 | The value must be set in the document constructor using the +:safe+ option. 11 | 12 | result = Asciidoctor.convert_file('master.adoc', :safe => 'server') 13 | 14 | or 15 | 16 | result = Asciidoctor.convert_file('master.adoc', :safe => :server) 17 | 18 | or 19 | 20 | result = Asciidoctor.convert_file('master.adoc', :safe => 10) 21 | -------------------------------------------------------------------------------- /docs/_includes/relative-include.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | === Include files relative to a common source directory 3 | 4 | This content is included in the user manual 5 | //// 6 | 7 | Asciidoctor expands attributes in the target of the include directive. 8 | That means you only have to type the unique part of the path when linking to a source file. 9 | 10 | Example: 11 | 12 | [source] 13 | .... 14 | :sourcedir: src/main/java 15 | 16 | [source,java] 17 | ---- 18 | \include::{sourcedir}/org/asciidoctor/Asciidoctor.java[] 19 | ---- 20 | .... 21 | 22 | The target of the include resolves to: 23 | 24 | src/main/java/org/asciidoctor/Asciidoctor.java 25 | -------------------------------------------------------------------------------- /docs/_includes/pass-intro.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Macro and Block Passthroughs 5 | //// 6 | 7 | Passthroughs are the "`anything goes`" mechanism in Asciidoctor. 8 | As its name implies, a passthrough passes its contents directly to the output document. 9 | The contents of a passthrough are excluded from all <>. 10 | 11 | WARNING: Using passthroughs to pass content without processing can couple your document to a specific output format, such as HTML. 12 | In these cases, you can use conditional preprocessor directives to declare passthrough markup for each backend you need to support. 13 | -------------------------------------------------------------------------------- /docs/_includes/project-author.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Authors 5 | //// 6 | 7 | *Asciidoctor* was written by {mojavelinux}[Dan Allen], {erebor}[Ryan Waldron], {lightguard}[Jason Porter], {nickh}[Nick Hengeveld] and {contributors}[other contributors]. 8 | 9 | The initial code from which Asciidoctor emerged was written by {nickh}[Nick Hengeveld] to process the git man pages for the {gitscm-next}[Git project site]. 10 | Refer to the commit history of {seed-contribution}[asciidoc.rb] to view the initial contributions. 11 | 12 | *AsciiDoc* was written by Stuart Rackham and has received contributions from many other individuals. 13 | -------------------------------------------------------------------------------- /docs/_includes/subs-group-table.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Blocks, Substitutions 5 | //// 6 | 7 | .Substitution groups 8 | [cols="2h,6*^"] 9 | |=== 10 | |Group |Special characters |Quotes |Attributes |Replacements |Macros |Post replacements 11 | 12 | |Header 13 | |{y} 14 | |{n} 15 | |{y} 16 | |{n} 17 | |{n} 18 | |{n} 19 | 20 | |None 21 | |{n} 22 | |{n} 23 | |{n} 24 | |{n} 25 | |{n} 26 | |{n} 27 | 28 | |Normal 29 | |{y} 30 | |{y} 31 | |{y} 32 | |{y} 33 | |{y} 34 | |{y} 35 | 36 | |Pass 37 | |{n} 38 | |{n} 39 | |{n} 40 | |{n} 41 | |{n} 42 | |{n} 43 | 44 | |Verbatim 45 | |{y} 46 | |{n} 47 | |{n} 48 | |{n} 49 | |{n} 50 | |{n} 51 | |=== 52 | -------------------------------------------------------------------------------- /javascripts/view-result.js: -------------------------------------------------------------------------------- 1 | function toggle_result_block(result_block) { 2 | result_block.prev().toggleClass('stacked'); 3 | result_block.toggle(); 4 | } 5 | 6 | function insert_result_links() { 7 | $('.result').each(function(idx, node) { 8 | var result_block = $(node); 9 | var title_div = result_block.prev().find('.title'); 10 | var view_result_link = $('view result'); 11 | title_div.append(view_result_link); 12 | view_result_link.on('click', function(event) { 13 | event.preventDefault(); 14 | toggle_result_block(result_block); 15 | }); 16 | }); 17 | } 18 | 19 | $(insert_result_links); 20 | -------------------------------------------------------------------------------- /docs/_includes/ex-sidebar.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Sidebar 5 | - quick-ref 6 | //// 7 | 8 | // tag::base-c[] 9 | .AsciiDoc history // <1> 10 | **** // <2> 11 | AsciiDoc was first released in Nov 2002 by Stuart Rackham. 12 | It was designed from the start to be a shorthand syntax 13 | for producing professional documents like DocBook and LaTeX. 14 | **** 15 | // end::base-c[] 16 | 17 | // tag::base[] 18 | .AsciiDoc history 19 | **** 20 | AsciiDoc was first released in Nov 2002 by Stuart Rackham. 21 | It was designed from the start to be a shorthand syntax 22 | for producing professional documents like DocBook and LaTeX. 23 | **** 24 | // end::base[] 25 | -------------------------------------------------------------------------------- /docs/_includes/html-ruby-api.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | HTML output section 3 | 4 | == Using the Ruby API 5 | 6 | This document is included in render-documents and the user-manual. 7 | TODO: expand this section 8 | //// 9 | 10 | Asciidoctor also includes a Ruby API that lets you generate an HTML document directly from a Ruby application. 11 | 12 | [source,ruby] 13 | ---- 14 | require 'asciidoctor' 15 | 16 | Asciidoctor.convert_file('mysample.adoc', :in_place => true) 17 | ---- 18 | 19 | Alternatively, you can capture the HTML output in a variable instead of writing it to a file. 20 | 21 | [source,ruby] 22 | ---- 23 | html = Asciidoctor.convert_file('mysample.adoc', :header_footer => true) 24 | puts html 25 | ---- 26 | -------------------------------------------------------------------------------- /_ext/tagger_patch.rb: -------------------------------------------------------------------------------- 1 | module Awestruct::Extensions 2 | # This patch is necessary when both the posts and the index of posts are 3 | # nested in a subdirectory (e.g., /news). It fixes the problem of the 4 | # subdirectory getting appended to the end of tag URLs (e.g., /news/tag/tagname/news/) 5 | class TaggerPatch 6 | def initialize(prop_name = :posts) 7 | @prop_name = prop_name 8 | end 9 | 10 | def execute(site) 11 | tags = site.send("#{@prop_name}_tags") 12 | tags.each do |tag| 13 | original_output_path = tag.primary_page.output_path 14 | tag.primary_page.output_path = File.join(File.dirname(original_output_path), 'index.html') 15 | end 16 | end 17 | end 18 | end 19 | -------------------------------------------------------------------------------- /docs/_includes/factory-apply.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Stylesheet Factory: Applying a stylesheet 5 | //// 6 | 7 | Let's practice applying a stylesheet to a simple AsciiDoc file. 8 | 9 | . Create an AsciiDoc file like the one below. 10 | . Save the file as [path]'sample.adoc'. 11 | 12 | // end 13 | 14 | [source] 15 | ---- 16 | = Introduction to AsciiDoc 17 | Doc Writer 18 | 19 | A preface about http://asciidoc.org[AsciiDoc]. 20 | 21 | == First Section 22 | 23 | * item 1 24 | * item 2 25 | 26 | [source,ruby] 27 | puts "Hello, World!" 28 | ---- 29 | 30 | Next, you'll use the Asciidoctor processor to generate HTML and apply a stylesheet to it from the [path]'stylesheets/' directory. 31 | -------------------------------------------------------------------------------- /docs/_includes/para-lead.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: paragraphs: lead 5 | //// 6 | 7 | Apply the `lead` style to any paragraph, and it will render using a larger font size. 8 | The lead style is assigned to the <>. 9 | You can set `role` using the long- or shorthand method. 10 | 11 | .Setting role using shorthand (`.`) and assigning it the lead value 12 | [source] 13 | ---- 14 | include::ex-text.adoc[tags=lead] 15 | ---- 16 | 17 | .Rendered lead paragraph 18 | ==== 19 | include::ex-text.adoc[tags=lead] 20 | ==== 21 | 22 | When you render a document using the default backend and stylesheet, the first paragraph of the preamble is automatically styled as a lead paragraph. 23 | -------------------------------------------------------------------------------- /docs/_includes/book-part.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual 5 | //// 6 | 7 | You can group the sections of your document into parts. 8 | Parts can only be used when the `doctype` is `book`. 9 | Part titles are specified with a single equals sign (`=`), the equivalent to a document title, i.e. section level 0. 10 | After the part title, you can include an optional introduction, which is designated by the `partintro` attribute. 11 | 12 | ---- 13 | [partintro] 14 | .Optional part introduction title 15 | -- 16 | Optional part introduction goes here. 17 | -- 18 | ---- 19 | 20 | A part can also include its own preface, bibliography, glossary and index. 21 | 22 | ---- 23 | include::multi-special-ex.adoc[tags=part] 24 | ---- 25 | -------------------------------------------------------------------------------- /docs/_includes/sum-section.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: sections 5 | //// 6 | 7 | .Section attributes and values 8 | [cols="1m,1,2m,2"] 9 | |=== 10 | |Attribute |Value(s) |Example Syntax |Comments 11 | 12 | |sectid 13 | |N/A 14 | |+:sectid!:+ 15 | |Intrinsic; set to autogenerate by default 16 | 17 | |idprefix 18 | |`_`, or user defined text 19 | |+:idprefix: -+ 20 | |Intrinsic; set to autogenerate a `_` by default 21 | 22 | |sectanchors 23 | |N/A 24 | |+:sectanchors:+ 25 | |Asciidoctor only 26 | 27 | |sectlinks 28 | |N/A 29 | |+:sectlinks:+ 30 | |Asciidoctor only 31 | 32 | |sectnums 33 | |N/A 34 | |+:sectnums:+ 35 | |Section numbering is off by default. 36 | Can be toggled on or off through document. 37 | |=== 38 | -------------------------------------------------------------------------------- /docs/_includes/ex-ui.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: User Interface Macros 5 | - quick-ref 6 | //// 7 | 8 | // tag::key[] 9 | |=== 10 | |Shortcut |Purpose 11 | 12 | |kbd:[F11] 13 | |Toggle fullscreen 14 | 15 | |kbd:[Ctrl+T] 16 | |Open a new tab 17 | 18 | |kbd:[Ctrl+Shift+N] 19 | |New incognito window 20 | 21 | |kbd:[Ctrl + +] 22 | |Increase zoom 23 | |=== 24 | // end::key[] 25 | 26 | // tag::menu[] 27 | To save the file, select menu:File[Save]. 28 | 29 | Select menu:View[Zoom > Reset] to reset the zoom level to the default setting. 30 | // end::menu[] 31 | 32 | // tag::button[] 33 | Press the btn:[OK] button when you are finished. 34 | 35 | Select a file in the file navigator and click btn:[Open]. 36 | // end::button[] 37 | -------------------------------------------------------------------------------- /contributors.html.slim: -------------------------------------------------------------------------------- 1 | --- 2 | layout: base 3 | --- 4 | - contributors = YAML.load_file '_config/contributors.yml' 5 | - page.title = %[Contributors and Participants #{contributors.size}] 6 | p 7 | |This page showcases our awesome community! The following people have either contributed to, participated in, supported or evangelized Asciidoctor. From all of us in the Asciidoctor community, we hope you enjoy using the Asciidoctor toolchain! 8 | .small-block-grid-3.large-block-grid-4 9 | - contributors.each do |contributor| 10 | li 11 | a href=contributor[:html_url] 12 | img.th src=contributor[:avatar_url] alt=contributor[:login] 13 | h6 style='margin: 0.2em 0 0 0; line-height: 1.2; text-align: right' =contributor[:name] 14 | -------------------------------------------------------------------------------- /docs/_includes/html-manage-images.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | HTML output section 3 | 4 | === Managing images 5 | 6 | This document is included in render-documents and the user-manual. 7 | //// 8 | 9 | Images are not embedded in the HTML output by default. 10 | If you have image references in your document, you'll have to save the image files in the same directory as your rendered document. 11 | Or, by passing the `data-uri` attribute to the processor, you can embed the images into the document. 12 | 13 | To embed images into the HTML output, set data-uri on the command line or in the document's header. 14 | 15 | $ asciidoctor -a data-uri mysample.adoc 16 | 17 | ---- 18 | include::mysample-data-uri.adoc[] 19 | ---- 20 | 21 | ==== 22 | image::mysample-data-uri.png[] 23 | ==== 24 | -------------------------------------------------------------------------------- /docs/_includes/verse.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: verse 5 | //// 6 | 7 | When you need to preserve indents and line breaks, use the `verse` block name. 8 | Verses are defined by setting `verse` on a paragraph or an excerpt block delimited by four underscores (`____`). 9 | 10 | .Verse paragraph syntax 11 | [source] 12 | ---- 13 | include::ex-verse.adoc[tags=para] 14 | ---- 15 | 16 | .Result: Verse paragraph 17 | ==== 18 | include::ex-verse.adoc[tags=para] 19 | ==== 20 | 21 | When the verse content includes blank or indented lines, enclose it in an excerpt block. 22 | 23 | .Verse delimited block syntax 24 | ---- 25 | include::ex-verse.adoc[tags=bl] 26 | ---- 27 | 28 | .Result: verse block 29 | ==== 30 | include::ex-verse.adoc[tags=bl] 31 | ==== 32 | -------------------------------------------------------------------------------- /docs/_includes/abstract.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual 5 | //// 6 | 7 | An abstract is a concise overview of an article. 8 | Typically found in the frontmatter of academic, research, and analytical papers, an abstract can be classified as structured or unstructured and complete or limited. 9 | Abstracts with subheadings are structured abstracts, whereas abstracts without subheadings are unstructured. 10 | A complete (informative) abstract states the key topics and findings of the paper while a limited (descriptive) abstract briefly describes the structure of the article. 11 | An abstract title is not necessary. 12 | 13 | ---- 14 | [abstract] 15 | == Documentation Abstract 16 | 17 | Documentation is a distillation of many long, squiggly adventures. 18 | ---- 19 | -------------------------------------------------------------------------------- /docs/_includes/pass-block.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Macro and Block Passthroughs: Block passthroughs 5 | //// 6 | 7 | The `pass` style and delimited passthrough block exclude blocks of content from all substitutions. 8 | 9 | The pass style can be set on a paragraph or an open block. 10 | 11 | [source] 12 | ---- 13 | include::ex-pass.adoc[tags=pass-style] 14 | ---- 15 | 16 | A block passthrough is delimited by four plus signs (`{plus}{plus}{plus}{plus}`). 17 | 18 | [source] 19 | ---- 20 | include::ex-pass.adoc[tags=bl] 21 | ---- 22 | 23 | If you want substitutions to be performed on the content in a delimited passthrough block, you can add them using the `subs` attribute. 24 | 25 | [source] 26 | ---- 27 | include::ex-pass.adoc[tags=subs-bl] 28 | ---- 29 | -------------------------------------------------------------------------------- /docs/_includes/preamble.adoc: -------------------------------------------------------------------------------- 1 | = The Dangerous and Thrilling Documentation Chronicles 2 | Kismet Chameleon 3 | 4 | This journey begins on a bleary Monday morning. 5 | Our intrepid team is in desperate need of double shot mochas, but the milk expired eight days ago. 6 | A trip to the dairy was out of the question. 7 | On Friday night, a mutant, script-injecting warlock had infected the Shetland cattle herd with a ravenous craving for tags and annotations. 8 | The security wolves were at a trust building retreat in Katchanga, and no one in the village could locate their defensive operations manual. 9 | 10 | Weak daylight trickled across the stripped pasture, chased by distant bovine screams... 11 | 12 | == Cavern Glow 13 | 14 | The river rages through the cavern, rattling its content... 15 | -------------------------------------------------------------------------------- /docs/_includes/url-relative.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: relative links 5 | - writers-guide 6 | //// 7 | 8 | If you want to link to an external file relative to the current document, use the `link` macro in front of the file name. 9 | 10 | [source] 11 | ---- 12 | include::ex-url.adoc[tags=link] 13 | ---- 14 | 15 | If your file is an HTML file, you can link directly to a section in the document, append a hash (`#`) followed by the section's ID to the end of the file name. 16 | 17 | [source] 18 | ---- 19 | include::ex-url.adoc[tags=hash] 20 | ---- 21 | 22 | //// 23 | You can also create links that refer to sections within the current document. 24 | 25 | [source] 26 | ---- 27 | link:user-manual.html[URLs] 28 | ---- 29 | 30 | ==== 31 | link:user-manual.html[URLs] 32 | ==== 33 | //// 34 | -------------------------------------------------------------------------------- /docs/_includes/callout-xml.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: callouts: XML-friendly callouts 5 | //// 6 | 7 | XML doesn't have line comments, so our "`tuck the callout behind a line comment`" trick doesn't work here. 8 | To use callouts in XML, you must place the callout's angled brackets around the the XML comment and callout number. 9 | 10 | Here's how it appears in a listing: 11 | 12 | [source,subs=specialcharacters] 13 | .... 14 | include::ex-callout.adoc[tags=source-xml] 15 | .... 16 | 17 | Here's how it looks when rendered: 18 | 19 | ==== 20 | include::ex-callout.adoc[tags=source-xml] 21 | ==== 22 | 23 | Notice the comment has been replaced with a circled number that cannot be selected. 24 | Now both you and the reader can copy and paste XML source code containing callouts without worrying about errors. 25 | -------------------------------------------------------------------------------- /docs/_includes/ex-table-data.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Examples for table data format section 3 | //// 4 | 5 | // tag::csv[] 6 | [format="csv", options="header"] 7 | |=== 8 | Artist,Track,Genre 9 | Baauer,Harlem Shake,Hip Hop 10 | The Lumineers,Ho Hey,Folk Rock 11 | |=== 12 | // end::csv[] 13 | 14 | // tag::dsv[] 15 | [format="dsv", options="header"] 16 | |=== 17 | Artist:Track:Genre 18 | Robyn:Indestructable:Dance 19 | The Piano Guys:Code Name Vivaldi:Classical 20 | |=== 21 | // end::dsv[] 22 | 23 | // tag::s-csv[] 24 | ,=== 25 | Artist,Track,Genre 26 | 27 | Baauer,Harlem Shake,Hip Hop 28 | ,=== 29 | // end::s-csv[] 30 | 31 | // tag::s-dsv[] 32 | :=== 33 | Artist:Track:Genre 34 | 35 | Robyn:Indestructable:Dance 36 | :=== 37 | // end::s-dsv[] 38 | 39 | // tag::i-csv[] 40 | |=== 41 | \include::customers.csv[] 42 | |=== 43 | // end::i-csv[] 44 | -------------------------------------------------------------------------------- /docs/_includes/subs-attr.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Text Substitutions: Attributes 5 | //// 6 | 7 | Attribute references are replaced with their values when they're processed by the `attributes` substitution. 8 | 9 | .Elements subject to attributes text substitution 10 | [width="40%", cols="3,^2"] 11 | |=== 12 | |Element | `attributes` substitution 13 | 14 | |Attribute value |{y} 15 | 16 | |Comment |{n} 17 | 18 | |Example |{y} 19 | 20 | |Fenced |{n} 21 | 22 | |Header |{y} 23 | 24 | |Literal |{n} 25 | 26 | |Listing |{n} 27 | 28 | |Macro |{y} 29 | 30 | |Open |Varies 31 | 32 | |Paragraph |{y} 33 | 34 | |Passthrough |{n} 35 | 36 | |Quote |{y} 37 | 38 | |Sidebar |{y} 39 | 40 | |Source |{n} 41 | 42 | |Special sections |{y} 43 | 44 | |Table |Varies 45 | 46 | |Title |{y} 47 | 48 | |Verse |{y} 49 | 50 | |=== 51 | -------------------------------------------------------------------------------- /docs/_includes/subs-post.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Text Substitutions: Post Replacements 5 | //// 6 | 7 | The line break character, `{plus}`, is replaced when the `post_replacements` process runs. 8 | 9 | .Elements subject to post replacements text substitution 10 | [width="40%", cols="3,^2"] 11 | |=== 12 | |Element | `post_replacements` substitution 13 | 14 | |Attribute value |{y} 15 | 16 | |Comment |{n} 17 | 18 | |Example |{y} 19 | 20 | |Fenced |{n} 21 | 22 | |Header |{y} 23 | 24 | |Literal |{n} 25 | 26 | |Listing |{n} 27 | 28 | |Macro |{y} 29 | 30 | |Open |Varies 31 | 32 | |Paragraph |{y} 33 | 34 | |Passthrough |{n} 35 | 36 | |Quote |{y} 37 | 38 | |Sidebar |{y} 39 | 40 | |Source |{n} 41 | 42 | |Special sections |{y} 43 | 44 | |Table |Varies 45 | 46 | |Title |{y} 47 | 48 | |Verse |{y} 49 | 50 | |=== 51 | -------------------------------------------------------------------------------- /_partials/pagination.html.slim: -------------------------------------------------------------------------------- 1 | - paginator = page.paginator 2 | .pagination-centered 3 | ul.pagination 4 | - if paginator.previous_page 5 | li.arrow : a href=paginator.pages.first.url : i.fa.fa-fast-backward 6 | li.arrow : a href=paginator.previous_page.url : i.fa.fa-step-backward 7 | - else 8 | li.arrow.unavailable : a href='#' : i.fa.fa-fast-backward 9 | li.arrow.unavailable : a href='#' : i.fa.fa-step-backward 10 | li #{paginator.current_page_index + 1} of #{paginator.pages.size} 11 | - if paginator.next_page 12 | li.arrow : a href=paginator.next_page.url : i.fa.fa-step-forward 13 | li.arrow : a href=paginator.pages.last.url : i.fa.fa-fast-forward 14 | - else 15 | li.arrow.unavailable : a href='#' : i.fa.fa-step-forward 16 | li.arrow.unavailable : a href='#' : i.fa.fa-fast-forward 17 | -------------------------------------------------------------------------------- /docs/_includes/include-relative-leveloffset.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | === Relative leveloffset 3 | 4 | This content is included in the user manual 5 | //// 6 | 7 | 8 | The `leveloffset` attribute is used to {uri-asciidoc-leveloffset}[shift the level of sections] when combining documents. 9 | It works great for a single include level, but it quickly breaks down when you get into multiple levels of nesting. 10 | 11 | The problem is that the level offset value is assumed to be absolute. 12 | Asciidoctor now supports _relative_ level offset values using a leading + or - operator. 13 | 14 | :leveloffset: +1 15 | include::chapter-01.adoc[] 16 | :leveloffset: -1 17 | 18 | Alternatively, you can specify the `leveloffset` attribute directly on the include directive so you don't have to worry about restoring the old value. 19 | 20 | include::chapter-01.adoc[leveloffset=+1] 21 | -------------------------------------------------------------------------------- /docs/_includes/para.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: paragraphs 5 | - writers-guide: content is king 6 | //// 7 | 8 | The bulk of the content in a document is paragraph text. 9 | This is why Asciidoctor doesn't require any special markup or attributes to specify paragraph content. 10 | You can just start typing. 11 | 12 | In Asciidoctor, adjacent or consecutive lines of text form a paragraph element. 13 | To start a new paragraph after another element, such as a section title or table, hit the kbd:[RETURN] key twice to insert a blank line, and then continue typing your content. 14 | 15 | .Two paragraphs in an AsciiDoc document 16 | [source] 17 | ---- 18 | include::ex-text.adoc[tags=para] 19 | ---- 20 | 21 | .The two paragraphs rendered using the default (html5) converter and stylesheet (asciidoctor.css) 22 | ==== 23 | include::ex-text.adoc[tags=para] 24 | ==== 25 | -------------------------------------------------------------------------------- /docs/_includes/subs-macro.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Text Substitutions: Macros 5 | //// 6 | 7 | Macros are processed by the `macros` element. 8 | The macros substitution replaces a macro's content with the appropriate built-in and user-defined configuration. 9 | 10 | .Elements subject to macros substitution 11 | [width="40%", cols="3,^2"] 12 | |=== 13 | |Element | `macros` substitution 14 | 15 | |Attribute value |{y} 16 | 17 | |Comment |{n} 18 | 19 | |Example |{y} 20 | 21 | |Fenced |{n} 22 | 23 | |Header |{y} 24 | 25 | |Literal |{n} 26 | 27 | |Listing |{n} 28 | 29 | |Macro |{y} 30 | 31 | |Open |Varies 32 | 33 | |Paragraph |{y} 34 | 35 | |Passthrough |{y} 36 | 37 | |Quote |{y} 38 | 39 | |Sidebar |{y} 40 | 41 | |Source |{n} 42 | 43 | |Special sections |{y} 44 | 45 | |Table |Varies 46 | 47 | |Title |{y} 48 | 49 | |Verse |{y} 50 | 51 | |=== 52 | -------------------------------------------------------------------------------- /docs/_includes/sum-toc.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual 5 | //// 6 | 7 | [cols="1m,1,2m,2,1"] 8 | .Table of contents attributes and values 9 | |=== 10 | |Attribute |Values |Example Syntax |Comments |Backends 11 | 12 | |toc 13 | |`auto`, `left`, `right`, `macro` 14 | |:toc: 15 | |DocBook backend sets it by default. Use `macro` in order to use the `+toc::[]+` macro in the document body. 16 | |html, docbook 17 | 18 | |toclevels 19 | |`1`, `2`, `3`, `4`, `5` 20 | |:toclevels: 4 21 | |Default value is 2. 22 | |html 23 | 24 | |toc-placement 25 | |`auto`, `preamble` 26 | |:toc-placement: preamble 27 | |Detault value is `auto`. 28 | |html 29 | 30 | |toc-position 31 | |`left`, `right` 32 | |:toc-position: right 33 | | 34 | |html 35 | 36 | |toc-title 37 | |user defined 38 | |:toc-title: Rocking the Table 39 | |Default title is _Table of Contents_. 40 | |html 41 | 42 | |=== 43 | -------------------------------------------------------------------------------- /docs/_includes/secure-cli.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Running Asciidoctor Securely: Set the safe mode in the CLI 5 | //// 6 | 7 | When Asciidoctor is invoked via the CLI, the safe mode is set to +UNSAFE+ by default. 8 | You can change the safe level by executing one of the following commands in the CLI. 9 | 10 | +-S+, +--safe-mode=SAFE_MODE+:: 11 | Sets the safe mode level of the document according to the assigned level (+UNSAFE+, +SAFE+, +SERVER+, +SECURE+). 12 | 13 | +--safe+, +asciidoctor-safe+:: 14 | Sets the safe mode level to +SAFE+. 15 | Provided for compatibility with the python AsciiDoc +safe+ command. 16 | 17 | //// 18 | -B, --base-dir=DIR 19 | Base directory containing the document and resources. Defaults to the directory containing the source file, or the working directory if the source is read from a stream. Can be used as a way to chroot the execution of the program. 20 | //// 21 | -------------------------------------------------------------------------------- /docs/_includes/html-code-styles.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | HTML output section 3 | 4 | === CodeRay and Pygments stylesheets 5 | 6 | This document is included in render-documents and the user-manual. 7 | //// 8 | 9 | Asciidoctor will also embed the theme stylesheet for the CodeRay or Pygments syntax highlighter. 10 | 11 | .CodeRay 12 | If the `source-highlighter` attribute is `coderay` and the `coderay-css` attribute is `class`, the CodeRay stylesheet is: 13 | 14 | * _embedded_ by default 15 | * _copied_ to the file [file]_asciidoctor-coderay.css_ inside the `stylesdir` folder within the output directory if `linkcss` is set 16 | 17 | .Pygments 18 | If the `source-highlighter` attribute is `pygments` and the `pygments-css` attribute is `class`, the Pygments stylesheet is: 19 | 20 | * _embedded_ by default 21 | * _copied_ to the file [file]_asciidoctor-pygments.css_ inside the `stylesdir` folder within the output directory if `linkcss` is set 22 | -------------------------------------------------------------------------------- /docs/_includes/subs-prevent.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | Included in: 3 | 4 | - user-manual: Text Substitutions: Preventing substitutions 5 | - writers-guide: preventing subs 6 | //// 7 | 8 | Asciidoctor provides several approaches for preventing substitutions. 9 | 10 | .Backslash escaping 11 | // tag::backslash[] 12 | To prevent punctuation from being interpreted as formatting markup, precede it with a backslash (`\`). 13 | If the formatting punctuation begins with two characters (e.g., `+__+`), you need to precede it with two backslashes (`+\\+`). 14 | This is also how you can prevent character and attribute references from substitution. 15 | When your document is processed, the backslash is removed so it doesn't display in your output. 16 | 17 | [source] 18 | ---- 19 | include::ex-subs.adoc[tags=slash] 20 | ---- 21 | 22 | // end::backslash[] 23 | You can also prevent substitutions with <>. 24 | -------------------------------------------------------------------------------- /docs/_includes/ex-keyword.adoc: -------------------------------------------------------------------------------- 1 | //// 2 | User Manual - keyword metadata example 3 | 4 | //// 5 | 6 | // tag::key-base[] 7 | = The Dangerous and Thrilling Documentation Chronicles 8 | Kismet Rainbow Chameleon ; Lazarus het_Draeke 9 | :keywords: documentation, team, obstacles, journey, victory 10 | 11 | This journey begins on a bleary Monday morning. 12 | // end::key-base[] 13 | 14 | // tag::key-html[] 15 | [source,xml] 16 | ---- 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | The Dangerous and Thrilling Documentation Chronicles 25 |