asciidoctor-html

A simple static site generator for AsciiDoc documents based on Asciidoctor.

Install the gem and add to the application's Gemfile by executing:

bundle add asciidoctor-html

If bundler is not being used to manage dependencies, install the gem by executing:

gem install asciidoctor-html

See the documentation's config.yml for an example of a configuration file. In a typical scenario, you would put your configuration file in the same directory as your AsciiDoc sources.

Assuming your config file is in the same directory as your AsciiDoc sources, execute:

cd ASCIIDOC_SOURCES_DIR
adoctohtml [--watch]

After checking out the repo, run bin/setup to install dependencies. Then, run bundle exec rake to run the tests. You can also run bin/cli to test the CLI after making changes.

Run jekyll serve --livereload inside the docs/html directory to preview your changes after running bundle exec rake.

To install this gem onto your local machine, run bundle exec rake install. To release a new version,

• update the version number in asciidoctor-html.gemspec,
• update the CHANGELOG.md,

and then run

bundle exec rake stylesheet
git commit -am "prepare for new release"
bundle exec rake release

The first line runs the tests and builds the stylesheet assets/css/styles.css. The third line creates a git tag for the version, pushes commits and the created tag to GitHub, and pushes the .gem file to rubygems.org.

The gem is available as open source under the terms of the MIT License.