anchor.diff:  :awestruct-layout: base
   :homepage: http://asciidoctor.org
   :asciidoc: http://asciidoc.org
  +:gem: http://rubygems.org/gems/asciidoctor
  +:toolchain: http://asciidoctor.org/docs/install-toolchain/
  +:install-mac: http://asciidoctor.org/docs/install-asciidoctor-macosx/
  +:render: http://asciidoctor.org/docs/render-documents
  +:factory: http://asciidoctor.org/docs/produce-custom-themes-using-asciidoctor-stylesheet-factory
  +:man: http://asciidoctor.org/man/asciidoctor 
   :sources: https://github.com/asciidoctor/asciidoctor
   :issues: https://github.com/asciidoctor/asciidoctor/issues
   :forum: http://discuss.asciidoctor.org
  +:irc: irc://irc.freenode.org/#asciidoctor
  +:news: http://asciidoctor.org/news/
  +:docs: http://asciidoctor.org/docs/
   :org: https://github.com/asciidoctor
   :contributors: https://github.com/asciidoctor/asciidoctor/graphs/contributors
   :templates: https://github.com/asciidoctor/asciidoctor/blob/master/lib/asciidoctor/backends
  
positive.code: :idprefix:
  :idseparator: -
  
  {homepage}[Asciidoctor] is a pure Ruby processor for converting
  {asciidoc}[AsciiDoc] source files and strings into HTML 5, DocBook 4.5
  and other formats. It's http://rubygems.org/gems/asciidoctor[published
  as a RubyGem] and is available under the MIT open source license.
  
  ifndef::awestruct[]
  image::https://travis-ci.org/asciidoctor/asciidoctor.png?branch=master[Build Status, link="https://travis-ci.org/asciidoctor/asciidoctor"]
  endif::awestruct[]
  
  Asciidoctor uses a set of built-in ERB templates to render the document
  to HTML 5 or DocBook 4.5. We've matched the rendered output as close as
  possible to the default output of the native Python processor. You can
  override this behavior by providing {tilt}[Tilt]-compatible templates.
  See the <<usage>> section for more details.
  
  Asciidoctor currently works (read as 'tested') with Ruby 1.8.7, Ruby
  1.9.3, Ruby 2.0.0, JRuby 1.7.4 and Rubinius nightly (on Linux, Mac and
  Windows). We expect it will work with other versions of Ruby as well and
  would welcome help in testing it out.
  
  The initial code from which Asciidoctor emerged was written by
  http://github.com/nickh[Nick Hengeveld] to process the git man pages for
  the {gitscm-next}[Git project site]. Refer to commit history of
  {seed-contribution}[asciidoc.rb] to view the initial contributions and
  contributors.
  
  The source code can now be found in the {sources}[Asciidoctor source
  repository] on GitHub.
  
  == Installation
  
  NOTE: We're working hard to make Asciidoctor a drop-in replacement for
  AsciiDoc. We're very close, with over 700 tests that ensure
  compatibility. The march is on towards full compliance and beyond.
  
  To install the gem:
  
   gem install asciidoctor
  
  Or if you prefer bundler, add the asciidoctor gem to your Gemfile,
  
   source 'https://rubygems.org'
   gem 'asciidoctor'
  
  then install it using bundler:
  
   bundle install
  
  If you're running Fedora, you can install the gem using yum:
  
   sudo yum install rubygem-asciidoctor
  
  The benefit of installing the gem via yum is that yum will also install
  Ruby if it's not already on your machine.
  
  == Usage
  
  Asciidoctor has both a command line interface (CLI) and an API. The CLI
  is a drop-in replacement for the +asciidoc.py+ command from the Python
  implementation. The API is intended for integration with other software
  projects and is suitable for server-side applications, such as Rails,
  Sinatra and GitHub.
  
  === Command line interface (CLI)
  
  After installing the +asciidoctor+ gem, the +asciidoctor+ commandline
  interface should be available on your PATH. To invoke it, simply execute:
  
   asciidoctor <asciidoc_file>
  
  This will use the built-in defaults for options and create a new file in
  the same directory as the input file, with the same base name, but with
  the .html extension.
  
  There are many other options available and full help is provided via:
  
   asciidoctor --help
  
  or in the http://asciidoctor.org/man/asciidoctor[man page].
  
  There is also an +asciidoctor-safe+ command, which turns on safe mode by
  default, preventing access to files outside the parent directory of the
  source file. This mode is very similar to the safe mode of
  +asciidoc.py+.
  
  === Ruby API
  
  To use Asciidoctor in your application, you first need to require the
  gem:
  
   require 'asciidoctor'
  
  
negative.code: . Add, commit, and push your changes.
  . {pr}[Submit a pull request].
  
  === Supporting Additional Ruby Versions
  
  If you would like this library to support another Ruby version, you may volunteer to be a maintainer. 
  Being a maintainer entails making sure all tests run and pass on that implementation. 
  When something breaks on your implementation, you will be personally responsible for providing patches in a timely fashion. 
  If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.
  
  // vim: tw=72
  