Course Orchestra Asciidoctor Extensions

This repository contains Asciidoctor extensions made by Course Orchestra for processing and publishing AsciiDoc content.

The extensions are available in both Ruby and JavaScript.

Note	Ruby extensions can be used in the JVM through JRuby.

Ruby

Install

$ gem install curs-asciidoctor-extensions

Usage

CLI

$ asciidoctor -r curs-asciidoctor-extensions doc.adoc

API

require 'curs/asciidoctor/extensions'

In addition, you can require individual extension:

require 'curs/asciidoctor/extensions/..'

See below for the complete list of extensions.

Release

The release process is automated and relies on GitHub Actions.

The RUBYGEMS_API_KEY secret is configured on GitHub. See the .github/workflows/release.yml file for details.

The release will be performed when a tag is pushed, the procedure is:

1. Change directory to ruby

2. Edit curs-asciidoctor-extensions.gemspec and update the version number s.version

3. Run bundle exec rake to make sure that everything is working

4. Commit both curs-asciidoctor-extensions.gemspec and Gemfile.lock files

5. Tag the version using git tag vx.y.z (don’t forget the v prefix and replace x.y.z with an actual version)

6. Push your changes with the tag: git push origin master --tags