ReSTructured text renderer for gitbucket
Scala
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
README.rst
build.sbt

README.rst

gitbucket-rst-plugin

Build Status
plugin-version:0.4.0
gitbucket-compat-version:4.10-4.14

A Git Bucket plug-in that provides ReSTructured text rendering capabilities. All .rst files will be automatically rendered as ReSTructured text, supporting most features of the LAIKA.

Compatibility with Gitbucket

This plugin version Gitbucket version
0.4.0, 0.3.0, 0.2.1, 0.2.0 4.10-4.14
0.1.0 4.5-4.9

Download

You can download a precompiled version from the Release.

Build from source

sbt clean package

The built package is located at target/scala-2.12/gitbucket-rst-plugin-{plugin-version}.jar.

sbt assembly

This makes the assembly package target/scala-2.12/gitbucket-rst-plugin-assembly-{plugin-version}.jar for deployment.

Installation

Download gitbucket-rst-plugin-assembly-{plugin-version}.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.

Thanks

This plug-in is based on asciidoctor plug-in.

This plug-in uses LAIKA as ReSTructued text renderer.

ChangeLog

gitbucket-rst-plugin 0.4.0 - 2017-04-29

  • Update LAIKA, ReST rendering library to 0.7.0
    • fix issue #4

gitbucket-rst-plugin 0.3.0 - 2017-04-13

  • Update LAIKA and use ExtendedHTML renderer for option list rendering
  • When rendering library throws exception, this plugin catch them and render raw ReST file, instead of crashing gitbucket server.

gitbucket-rst-plugin 0.2.1 - 2017-03-06

  • can be migrated from old versions

gitbucket-rst-plugin 0.2.0 - 2017-03-03

  • compatibility with gitbucket 4.10, scala 2.12 #2

gitbucket-rst-plugin 0.1.0 - 2016-10-02

  • Initial release