README.textile

MiniWiki

Small plugin to integrate a wiki in your website.

Requirements

• Rails >= 2.3
• RedCloth (developed with 3.0.4/4.1.9/4.2.2)
  gem install RedCloth
  And add the following to your config/environment.rb
config.gem 'RedCloth', :lib => 'redcloth', :version => '~> 4.2.2'

Install

1. ./script/plugin install git://github.com/tompesman/mini_wiki.git
2. ./script/generate mini_wiki
3. rake db:migrate
4. ./script/server
5. go to http://0.0.0.0:3000/mini_wiki/

Optional

you can add the map.root
map.root :controller => "mini_wiki"

Add authentication and username

It’s possible to add some security to the wiki. Edit the mini_wiki_override.rb
in the lib directory. The mini_wiki_authorized method should return a boolean
and the mini_wiki_username should return a string. Finaly add to the
app/controllers/application_controller.rb file include MiniWikiOverride to
activate the mini_wiki_override.rb module.

Usage

The wiki uses http://redcloth.org/textile formatting with one extension to make links
within the wiki: [[ThisIsALinkToANewPage]].

Copyright © 2009 Tom Pesman, released under the MIT license