Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Wikis as simple as we can make them.
Ruby
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
benchmarks
lib
spec
.gitignore
Gemfile
LICENSE
Rakefile
ReadMe.markdown
VERSION

ReadMe.markdown

Wimple

Wikis as simple as we can make them.

NOTE

First pass is just to get something running, we're not modularized yet!

Goals

Our goal is to design a modular versioning system for markup text that can be easily integrated into Ruby apps. It should be trivial to build a wiki app on top of.

  • versioned
  • collaborative (safe from clobbering)
  • stupid simple
  • lightweight
  • markup agnostic

Goals achieved

Markup Agnosticism

require 'wimple'
require 'wimple/strategies'
Wimple.register(:backwards){|str,opts| str.reverse } # first registered/used strategy is the default.
Wimple.use(:bluecloth)
Wimple.use(:redcloth)
Wimple.render("This isn't a palindrome") # default strategy is :backwards
# => "emordnilap a t'nsi sihT"
Wimple.render("#This is some Markdown!", :strategy=>:bluecloth)
# => <h1>This is some Markdown!</h1>
Wimple.render("h1. This is some Textile!", :strategy=>:redcloth)
# => <h1>This is some Textile!</h1>

Caveats

Options aren't exposed by the default strategies. They certainly could be accommodated on an ad hoc basis, but thought should be given to a general interface (if possible)

Things that would be nice to have

Intrawiki Linking

Default strategies which let you refer to other documents

Interwiki Linking

Default strategies for linking to some well known wikis.

Something went wrong with that request. Please try again.