A GitBucket plug-in that provided AsciiDoc rendering capabilities
Scala
Latest commit 1e2ccbb Jun 1, 2016 @lefou lefou Prepared next release

README.adoc

gitbucket-asciidoctor-plugin

Build Status Gitter Chat

A GitBucket plug-in that provides AsciiDoc rendering capabilities. All .adoc (and also the deprecated .asciidoc and .ad suffix) files will be automatically rendered as AsciiDoc, supporting most features of the Asciidoctor project, including rendering of a table of contents.

Download

You can download a precompiled version from the Release page.

Build from source

sbt clean package

The built package is located at target/scala-2.11/gitbucket-4.0-asciidoctor-plugin-1.0.1.jar.

sbt assembly

This makes the assembly package target/scala-2.11/gitbucket-4.0-asciidoctor-plugin-assembly-1.0.1.jar for deployment.

Installation

Download gitbucket-4.0-asciidoctor-plugin-assembly-1.0.1.jar or build the assembly package JAR file from source and copy it into GITBUCKET_HOME/plugins. If you have older versions of this plugin in this directory, you must delete them. Then restart GitBucket. That’s it.

License

This plugin is published under the Apache License, version 2.0.

ChangeLog

gitbucket-asciidoctor-plugin 1.0.1 - 2016-06-01

  • Post-process src attribute of generated <img> tags to point to raw image resource.

gitbucket-asciidoctor-plugin 1.0.0 - 2016-05-03

  • Set the outfilesuffix attribute to .adoc to properly support xref’s.

  • Introduced new attribute gitbucket-branch which contains the current selected git branch (or hash).

  • Requires GitBucket 4.0 or newer.

gitbucket-asciidoctor-plugin 0.1.1 - 2016-02-02

  • Updated some dependency versions.

  • Set the attributes env=gitbucket and env-gitbucket=true so that rendered pages can apply environment specific logic.

gitbucket-asciidoctor-plugin 0.1.0 - 2015-10-06

  • Initial release