Middleman AsciiDoc (middleman-asciidoc) is an extension for the Middleman static site generator that adds support for the AsciiDoc markup language using Asciidoctor.

Installation

If you’re just getting started, install the middleman gem and generate a new project:

$ gem install middleman
  middleman init MY_PROJECT

If you have an existing Middleman project, add gem "middleman-asciidoc" to your Gemfile and run bundle install.

Configuration

activate :asciidoc

You can also pass AsciiDoc configuration options to the underlying Asciidoctor processor:

activate :asciidoc, :asciidoc_attributes => %w(foo=bar)

The full set of options can be seen on your preview server’s /__middleman/config/ page.

Community

The official community forum is available at: http://forum.middlemanapp.com

Bug Reports

Github Issues are used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems at https://github.com/middleman/middleman-asciidoc/issues.

The best way to get quick responses to your issues and swift fixes to your bugs is to submit detailed bug reports, include test cases and respond to developer questions in a timely manner. Even better, if you know Ruby, you can submit Pull Requests containing Cucumber Features which describe how your feature should work or exploit the bug you are submitting.

How to Run Cucumber Tests

  1. Checkout Repository: git clone https://github.com/middleman/middleman-asciidoc.git

  2. Install Bundler: gem install bundler

  3. Run bundle install inside the project root to install the gem dependencies.

  4. Run test cases: bundle exec rake test

License

Copyright © 2014 Dan Allen. MIT Licensed, see LICENSE for details.