/codebook

A minimalistic code sharing plugin for redmine

Primary LanguageRubyOtherNOASSERTION

codebook

This plugin is a minimalistic shared knowledge database for teams using redmine. It uses the internal syntax highlighting of redmine (provided by the CodeRay plugin) and is primarily designed for keeping and sharing small pieces of source code or documentation.

Please let me know about any ideas or problems you encounter while using it.


Achtung

The current version of codebook requires and is compatible with Redmine 1.0.0+ (and newer 0.9+ versions of CodeRay) If, you want to use codebook with pre-1.0.0 versions of Redmine, please download the 0.2.1 tarball from the Downloads section.

Installation

  • in your redmine root,
    1. git clone https://github.com/oppara/codebook.git plugins/codebook
    2. bundle config set --local without 'development test'
    3. bundle config set --local path 'vendor/bundle'
    4. bundle install
    5. bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Todo

  • improve test coverage
  • add Export and Import
  • add a project view and bind certain code documents to a project
  • search integration (appears currently unsupported by redmine)

History

  • 0.3.1 fixed syntax highlighting for ant and pl/sql, cleaned up migrations
  • 0.3.0 works with Redmine 1.0.0, added cucumber and rspec tests
  • 0.2.1 moved category initialization into migration, no more extra "add default data" option
  • 0.2.0 changed plugin name and added localization files to make rails i18n work
  • 0.1.1 added settings panel to make the "display line numbers" setting a persistent option
  • 0.1.0 initial release

cheers Steffen