AsciiDoc-Bootstrap

How To

Build pages of this documentation.

Table of Contents

How to build examples pages

Filename Description

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/examples/navbar-default.asciidoc]
 navbar-default.asciidoc		 Standard & Default Navbar

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/examples/navbar-static.asciidoc]
 navbar-static.asciidoc		 Static Navbar

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/examples/navbar-fixed.asciidoc]
 navbar-fixed.asciidoc		 Fixed Navbar

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/examples/toc1.asciidoc]
 toc1.asciidoc		 Default TOC

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/examples/toc2.asciidoc]
 toc2.asciidoc		 Left or Right margin TOC

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/examples/blog1.asciidoc]
 blog1.asciidoc		 Basic Blog page

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/examples/blog2.asciidoc]
 blog2.asciidoc		 Blog Panel

[https://raw.github.com/llaville/asciidoc-bootstrap-backend/master/examples/release1.asciidoc]
 release1.asciidoc		 Basic Releases page

Boostrap 2 Version :

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

Boostrap 3 Version :

$ asciidoc -b bootstrap -a linkcss -a theme=flatly -a themedir=themes/3 -a bsver=3 -a navbar=fixed -a jumbotron -a toc -a totop=ui /path/to/docs/filename
Note
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 flatly Bootswatch theme for Bootstrap 2 or 3.

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

  • bsver used the Bootstrap template 2 or 3.

  • navbar used a top fixed navbar style.

  • jumbotron used a jumbotron to enhance main title.

  • toc used the standard Table Of Contents at start of the document.

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