Giter VIP home page Giter VIP logo

redmine_restructuredtext_formatter's Introduction

Redmine reStructuredText Formatter

This is a Redmine plugin for supporting reStructuredText as a wiki format using either RbST, which can convert all RST but is slow, or PandocRuby, which only supports a subset of RST but is fast.

Notes

RbST/docutils version (master branch)

This is potentially quite slow. RbST processes reStructuredText via Python's docutils, and docutils is slow. As far as I can tell, Redmine always formats text using a helper on each request, which means this plugin will likely add a few tenths of a second to each request, possibly more. On my machine, normal views take 450-550ms to render with the default textile option and 650-750 with this plugin. Heavily marked-up pages like the RST cheat sheet bumps it up to 1.2s. I wouldn't recommend this for public-facing pages, but it's probably OK for private Redmine instances.

PandocRuby version (pandoc-ruby branch)

Pandoc is much faster than docutils and should be roughly as fast as the native textile, but it only supports a subset of RST, so some features like tables are not available. This version is available on the pandoc-ruby branch. This branch doesn't have a toolbar.

Installation

RbST/docutils version

  • Install Python and docutils
  • gem install RbST
  • cd /path/to/redmine
  • script/plugin install git://github.com/ebrahim/redmine_restructuredtext_formatter.git
  • Start Redmine

PandocRuby version

  • Install Pandoc
  • gem install pandoc-ruby
  • cd /path/to/redmine/vendor/plugins
  • git clone git://github.com/alphabetum/redmine_restructuredtext_formatter.git
  • cd redmine_restructuredtext_formatter
  • git branch --track pandoc-ruby origin/pandoc-ruby
  • git checkout pandoc-ruby
  • Start Redmine

Notes

This plugin was derived directly from Larry Baltz's redmine_markdown_formatter.

redmine_restructuredtext_formatter's People

Contributors

ebrahim avatar xwmx avatar bitherder avatar mikoto20000 avatar zms avatar ryomatsumiya avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.