Skip to content

Latest commit

 

History

History
26 lines (14 loc) · 1.44 KB

README.asciidoc

File metadata and controls

26 lines (14 loc) · 1.44 KB

Bootstrap documentation-style backend for AsciiDoc

An AsciiDoc backend that renders the AsciiDoc source as HTML5 in the style of the Twitter Bootstrap docs.

Installation

To install the bootstrap docs backend, download bootstrap-docs.zip and install it using the asciidoc command (you will need AsciiDoc version 8.6.6 or newer):

asciidoc --backend install bootstrap-docs.zip

Next, checkout the Twitter Bootstrap repositor in the backend folder:

cd ~/.asciidoc/backends/bootstrap-docs
git clone git://github.com/twitter/bootstrap.git

If you enable the link-assets attribute, then you should also checkout (or symlink) the bootstrap clone in the same directory as the rendered file. You also need to create a symlink to asciidoc.js included in this backend.

Usage

Use the 'bootstrap-docs' backend as you would the built-in backends.

Example

As you would expect, the rendered output looks shockingly similar to the Twitter Bootstrap documentation.

Compare the original Base CSS chapter with the HTML output from this AsciiDoc source. Hey Twitter, want to switch to AsciiDoc?