A GitBucket plug-in that provided AsciiDoc rendering capabilities
Scala Makefile
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
project
src/main/scala
.gitignore
.travis.yml
LICENSE.txt
Makefile
README.adoc
build.sbt

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

With sbt
sbt assembly
Or with GNU Make
make build

You will find the packages plugin under target/scala_2.12/gitbucket-asciidoctor-plugin-gitbucket_4.26.0-1.1.1.jar

Installation

Download gitbucket-asciidoctor-plugin-gitbucket_4.26.0-1.1.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.

Local Test Server

You can start a local GitBucket instance with this plugin already installed by running:

make localServer

Point your browser to http://localhost:8080. The administrator login is root/root.

Configuration

Asciidoctor builtin attributes

You can tweak the asciidoctor rendering engine by customizing the builtin attributes. Simple edit the properties file at GITBUCKET_HOME/asciidoctor.properties.

Example: Set toc attribute in the GITBUCKET_HOME/asciidoctor.properties file
toc=preamble

License

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

ChangeLog

gitbucket-asciidoctor-plugin 1.0.2 - 2017-03-08

  • Added support to provide attributes to the asciidoctor engine via properties file in gitbucket directory.

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