# Getting Started

Overview of the project, its contents, and how to get started with your own theme.

# Download

Backend

Uncompressed, Minified CSS and Javascripts, and Fonts. Source files are included but without html documentation.

Download backend

Documentation

User documentation built with AsciiDoc-Boostrap backend and the default theme is available to read it offline.

Download html documentation

Install as any other plugins:

    $ asciidoc.py --backend install bootstrap-<version>.zip

`<version>` is to be replaced by the latest version available of the backend. Currently is 4.3.0

The Asciidoc Bootstrap backend standard version included :

- version 3.3.2 ( `themes/` ) of the default, flatly, readable, cerulean and united themes from Bootswatch template provider.

- version 3.3.2 ( `bootstrap/`, `less/bootstrap/` ) of Bootstrap.

- version 4.3.0 ( `fonts/`, `/less/font-awesome/` ) of Font-Awesome.

- version 2.0.1 ( `fonts/`, `less/ionicons/` ) of Ionicons.

- version 2.1.2 ( `fonts/`, `less/octicons/` ) of Octicons.

## Themes from Bootswatch a free template provider

AsciiDoc-Bootstrap backend v4 standard distribution included these following templates with pre-compiled CSS (uncompressed and/or minified) and default behavior :

- Admonition blocks used Font-Awesome icons font

- Support both Glyphicon, Font-Awesome and Ionicons icons font

### Basic Flatly theme

### Basic Readable theme

### Basic Cerulean theme

### Basic United theme

### Basic Sandstone theme

# File structure

When you will installed the asciidoc bootstrap backend, you will find the following file structure and contents.

     bootstrap/
      ├── bootstrap/
      │   ├── css/
      │   ├── fonts/
      │   └── js/
      ├── docs/
      ├── fonts/
      ├── images/
      │   ├── icons/
      │   │   ├── callouts/
      │   │   ├── ui.totop.png
      │   │   └── favicon.ico
      ├── javascripts/
      │   ├── asciidoc.js
      │   ├── html5shiv.js
      │   ├── html5shiv.min.js
      │   ├── jquery.js
      │   ├── jquery.min.js
      │   ├── jquery.ui.totop.js
      │   ├── jquery.ui.totop.min.js
      │   ├── respond.js
      │   └── respond.min.js
      ├── less/
      │   ├── asciidoc/
      │   │   ├── admonition-iconsfont.less
      │   │   ├── admonition-text.less
      │   │   ├── common.less
      │   │   ├── iconsfont.less
      │   │   └── pygments.less
      │   ├── bootstrap/
      │   ├── font-awesome/
      │   ├── ionicons/
      │   ├── octicons/
      │   ├── asciidoc-bootstrap.css
      │   └── variable.css
      ├── stylesheets/
      │   ├── asciidoc-bootstrap.cerulean.css
      │   ├── asciidoc-bootstrap.css
      │   ├── asciidoc-bootstrap.flatly.css
      │   ├── asciidoc-bootstrap.readable.css
      │   ├── asciidoc-bootstrap.united.css
      │   ├── asciidoc-bootstrap.sandstone.css
      │   ├── pygments.css
      │   ├── pygments.monokai.css
      │   ├── pygments.pastie.css
      │   └── ui.totop.css
      └── themes
          ├── cerulean/
          ├── default/
          ├── flatly/
          ├── readable/
          ├── sandstone/
          └── united/

# What is next?

Head to the docs sections for more information and examples.

## Source Code Highlight

The Pygments syntax highlighter can be used for xhtml11, html5 and bootstrap outputs.

Since version 3.1.0 you have ability to use any of the Pygments 1.5 themes provided at document build time.

## Text Formatting

Words and phrases can be formatted by enclosing inline text with quote characters.

## Delimited Blocks

Delimited blocks are blocks of text enveloped by leading and trailing delimiter lines

## Paragraphs

Paragraphs are blocks of text terminated by a blank line, the end of file, or the start of a delimited block or a list. There are three paragraph syntaxes: normal, indented (literal) and admonition which are rendered, by default, with the corresponding paragraph style.

## Document Structure

AsciiDoc has two mechanisms for optionally including additional meta-data in the header of the output document.

Like the `docinfo` attribute, bootstrap backend add support to dropdowns navigation bar with to new `navinfo` attribute. It also add support to bootstrap jumbotron component with the new `jumboinfo` attribute.

## Callouts

Callouts are a mechanism for annotating verbatim text (for example: source code, computer output and user input). Callout markers are placed inside the annotated text while the actual annotations are presented in a callout list after the annotated text.

## Macros

Macros are a mechanism for substituting parametrized text into output documents.

Macros have a name, a single target argument and an attribute list.

Inline Macros occur in an inline element context. Predefined Inline macros include image and link macros.

## Backend Attributes

List all specifics attributes of this backend.

## Customizing

AsciiDoc-Bootstrap v4 includes support of LESS one of the most popular CSS preprocessor.

Easy to maintain, and change skins of your favorite Asciidoc documents.