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.
You can download a precompiled version from the Release page.
sbt assembly
make build
You will find the packages plugin under target/scala_2.13/gitbucket-asciidoctor-plugin-gitbucket_4.32.0-1.1.0.jar
Download gitbucket-asciidoctor-plugin-gitbucket_4.32.0-1.1.0.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.
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.
You can tweak the asciidoctor rendering engine by customizing the
builtin attributes. Simple edit the properties file at GITBUCKET_HOME/asciidoctor.properties.
toc attribute in the GITBUCKET_HOME/asciidoctor.properties filetoc=preamble-
Support fot GitBucket 4.32.0
-
Updated dependencies
-
Added include support (for files in the same repository)
-
Added support to provide attributes to the asciidoctor engine via properties file in gitbucket directory.
-
Post-process
srcattribute of generated<img>tags to point to raw image resource.
-
Set the
outfilesuffixattribute to.adocto properly support xref’s. -
Introduced new attribute
gitbucket-branchwhich contains the current selected git branch (or hash). -
Requires GitBucket 4.0 or newer.
-
Updated some dependency versions.
-
Set the attributes
env=gitbucketandenv-gitbucket=trueso that rendered pages can apply environment specific logic.