Orchid Asciidoc

markup official

About

OrchidAsciidoc adds support for AsciiDoc markup in Orchid, as a replacement for Markdown.

Demo

Source
= My Article
J. Smith

https://wikipedia.org[Wikipedia] is an
on-line encyclopaedia, available in
English and *many* other languages.

== Software

You can install 'package-name' using
the `gem` command:

 gem install package-name

== Hardware

Metals commonly used include:

* copper
* tin
* lead
Result

Wikipedia is an on-line encyclopaedia, available in English and many other languages.

Software

You can install 'package-name' using the gem command:

gem install package-name

Hardware

Metals commonly used include:

  • copper

  • tin

  • lead

Usage

Simply include this plugin and you're all set. Orchid will now recognize files with file extensions of ad, adoc, asciidoc, or asciidoctor, and compile them as Asciidoc instead of Markdown, no further configuration necessary.

. / (resources root)
├── homepage.md
├── config.yml
└── pages/
    ├── page1.md
    └── page2.adoc <-- will be processed as AsciiDoc

Of course, you may also embed chunks of AsciiDoc markup within content of other formats using compileAs('adoc'):

## Markdown Header

{% filter compileAs('adoc') %} <-- filtered block will be processed as AsciiDoc
= AsciiDoc Header
{% endfilter %}
Include with:
dependencies {
    orchidRuntime 'io.github.javaeden.orchid:OrchidAsciidoc:0.17.1'
}
<dependency>
    <groupId>io.github.javaeden.orchid</groupId>
    <artifactId>OrchidAsciidoc</artifactId>
    <version>0.17.1</version>
    <type>pom</type>
</dependency>
@file:DependsOn("io.github.javaeden.orchid:OrchidAsciidoc:0.17.1")