https://github.com/jm/perwikity

An elegant wiki system for anyone who respects their grandmother
https://github.com/jm/perwikity

Last synced: 3 months ago
JSON representation

An elegant wiki system for anyone who respects their grandmother

• Host: GitHub
• URL: https://github.com/jm/perwikity
• Owner: jm
• Created: 2009-01-09T04:46:57.000Z (almost 16 years ago)
• Default Branch: master
• Last Pushed: 2010-09-28T03:05:22.000Z (about 14 years ago)
• Last Synced: 2024-05-31T20:01:34.935Z (5 months ago)
• Language: Ruby
• Homepage:
• Size: 4.12 MB
• Stars: 42
• Watchers: 4
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.rdoc

Awesome Lists containing this project

README

        
== 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...)