jeremymcanally / perwikity

Click here to lend your support to: perwikity and make a donation at www.pledgie.com !

An elegant wiki system for anyone who respects their grandmother

This URL has Read+Write access

handle wiki links like this [[link | description]]
manalang (author)
Mon Jan 26 14:46:25 -0800 2009
Jeremy McAnally (committer)
Tue Feb 03 10:42:08 -0800 2009
commit  789d14573f410039c891251c8ff771bf715b0425
tree    32c23d0a5c9f7efc916ec9083cef29a75390fa75
parent  85d6996c0f251e0987bdfa23b6c983df9c48a30f
name age
history
message
file README.rdoc Thu Jan 08 20:59:59 -0800 2009 README updates [Jeremy McAnally]
file Rakefile Thu Jan 08 20:47:42 -0800 2009 Initial commit!! [Jeremy McAnally]
directory app/ Tue Feb 03 10:42:08 -0800 2009 handle wiki links like this [[link | descriptio... [manalang]
directory config/ Thu Jan 08 20:47:42 -0800 2009 Initial commit!! [Jeremy McAnally]
directory db/ Thu Jan 08 20:47:42 -0800 2009 Initial commit!! [Jeremy McAnally]
directory doc/ Thu Jan 08 20:47:42 -0800 2009 Initial commit!! [Jeremy McAnally]
directory lib/ Thu Jan 08 20:47:42 -0800 2009 Initial commit!! [Jeremy McAnally]
directory public/ Fri Jan 09 17:33:15 -0800 2009 Add formatter markup helps to edit/new views. [Jeremy McAnally]
directory script/ Thu Jan 08 20:47:42 -0800 2009 Initial commit!! [Jeremy McAnally]
directory test/ Thu Jan 08 20:47:42 -0800 2009 Initial commit!! [Jeremy McAnally]
directory vendor/ Thu Jan 08 20:48:04 -0800 2009 Bye bye Rails [Jeremy McAnally]
README.rdoc

Perwikity — The picky wiki

by Jeremy McAnally

Perwikity is a simple to use and elegantly written wiki.

Installation and setup

Perwikity requires a few gems and applications be present on your system.

  • Git — Perwikity handles all of its versioning using Git (keeps the complexity low, the resilience high, and makes it dead simple to backup). You’ll need some version of Git (we don’t do anything fancy so any modern version should work).
  • grit — We use grit to interact with Git, so you’ll need to install the Grit gem, available from mojombo’s Github account.
  • A text formatter — You’ll need either the RedCloth gem (the default) installed, or you can configure Perwikity to use BlueCloth or any other text formatter (you’ll just have to do a little extra work to get others to work; see config/initializers/wiki_setup.rb for more information).
  • context — If you want to run the tests, you’ll need to install the context gem from my Github.

To setup Perwikity, you need to do a few things: 

  1. Download the application
  2. Rename the database.sample.yml file to database.yml
  3. Change the database details in said database.yml file
  4. Run rake app:setup to setup the database tables
  5. Visit config/initializers/wiki_setup.rb to setup your preferences
  6. Launch script/server
  7. Monkey around with the design or what have you
  8. Deploy!

It’s as simple as that.

TODO and the future

  • Test those helpers. Bad Rubyist! You didn’t TDD those!
  • Add ACL-type stuff with admins and roles and all that business
  • Add more user features, such as user pages
  • Syntax highlight when saving page (with configurable backends) rather than in JavaScript (fairly nasty temporary solution…)
  • Add configurable anti-spam measures
  • Search (with configurable engines…maybe…)