AsciiDoc-Bootstrap

How To

Build pages of this documentation.

Table of Contents

How to build the landing page

Filename Description

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/docs/index.asciidoc]
 index.asciidoc		 Home / Landing / Welcome page

Boostrap 2 Version :

$ asciidoc -b bootstrap -a linkcss -a theme=readable -a themedir=themes/2 -a bsver=2 -a jumbotron-fullwidth /path/to/docs/index.asciidoc

Boostrap 3 Version :

$ asciidoc -b bootstrap -a linkcss -a theme=readable -a themedir=themes/3 -a bsver=3 -a jumbotron-fullwidth /path/to/docs/index.asciidoc
Some explanations

  • linkcss reduce the size of html document. Default AsciiDoc behavior is: ``stylesheets and scripts are automatically embedded in the output document``.

  • theme is the standard Readable Bootswatch theme for Bootstrap 3.

  • themedir theme is loaded from local folder (outdir)/themes/2 (Bootstrap 2) and (outdir)/themes/3 (Bootstrap 3).

  • jumbotron-fullwidth used a full-width jumbotron in all resolution.

  • bsver used the Bootstrap 3 template.

How to build internal pages

Filename Description

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/docs/getting-started.asciidoc]
 getting-started.asciidoc		 Getting Started

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/docs/source-code-highlight.asciidoc]
 source-code-highlight.asciidoc		 Source Code Highlight

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/docs/text-formatting.asciidoc]
 text-formatting.asciidoc		 Text Formatting

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/docs/delimited-blocks.asciidoc]
 delimited-blocks.asciidoc		 Delimited Blocks

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/docs/paragraphs.asciidoc]
 paragraphs.asciidoc		 Paragraphs

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/docs/document-structure.asciidoc]
 document-structure.asciidoc		 Document Structure

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/docs/macros.asciidoc]
 macros.asciidoc		 Macros

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/docs/howto.asciidoc]
 howto.asciidoc		 How To

Boostrap 2 Version :

$ asciidoc -b bootstrap -a linkcss -a theme=readable -a themedir=themes/2 -a bsver=2 -a navbar=fixed -a jumbotron -a totop=ui /path/to/docs/filename

Boostrap 3 Version :

$ asciidoc -b bootstrap -a linkcss -a theme=readable -a themedir=themes/3 -a bsver=3 -a navbar=fixed -a jumbotron -a totop=ui /path/to/docs/filename
Some explanations

  • linkcss reduce the size of html document. Default AsciiDoc behavior is: ``stylesheets and scripts are automatically embedded in the output document``.

  • theme is the standard readable Bootswatch theme for Bootstrap 3.

  • themedir theme is loaded from local folder (outdir)/themes/2 (Bootstrap 2) and (outdir)/themes/3 (Bootstrap 3).

  • bsver used the Bootstrap 3 template.

  • navbar used a top fixed navbar style.

  • jumbotron used a jumbotron to enhance main title.

  • totop used a jQuery plugin to allow to easily scroll back to top of the document.