Skip to content

skanade/simplewiki

Repository files navigation

simplewiki

A simple wiki - use it as a personal wiki notebook

https://github.com/skanade/simplewiki/wiki (see screenshot)

Here are steps to get this running on your machine:

  1. First, download & install Ruby 2.x (developed with Ruby 1.9.3 originally and runs successfully with Ruby 2.3.3, 2.6.5)

  2. Then install the bundler gem

  • gem install bundler
  1. Run bundle install to install gems in Gemfile
  • bundle install
  1. Install RedCloth gem (optional)
  • gem install RedCloth (optional - you can also run without RedCloth, with a limited subset of markdown)
  1. Startup the sinatra instance with:
  ruby main.rb

OR if you want to run with RedCloth:

  REDCLOTH=true ruby main.rb
  1. Open a browser to:

http://localhost:4567

You should see the last page that was modified, which probably is the 'ruby_index' page.

Note: this currently only works on firefox and chrome and safari. It doesn't look quite right on internet explorer.

Enjoy!

RedCloth

By default, this simplewiki will run without RedCloth and instead use a limited subset of Markdown which is implemented internally.

If you want to use RedCloth instead, you still can by running with the REDCLOTH=true environment variable.

If you want to use RedCloth on Windows though, you will have to first do the following:

Behind a Firewall

If you're behind a firewall and you can't install remote gems, you'll have to download sinatra and its dependencies such as: rack, rack-protection, tilt, and RedCloth as .gem files to your PC. Then make sure you have LOAD_PATH=. and install each gem:

  • gem install Gemname (ex: gem install tilt)

About

A simple wiki - use it as a personal wiki notebook

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published