Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Lightweight wiki with git backend
JavaScript Ruby
tree: 3feeb18623

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
config
deps
doc
lib
plugins
static
test
tools
views
.gitignore
.gitmodules
README.markdown
Rakefile
config.ru
console.rb

README.markdown

README

Ōlelo is a wiki that stores pages in a Git repository. See the demo installation at http://git.awiki.org/.

Features

A lot of the features are implemented as plugins.

  • Edit, move or delete pages
  • Support for hierarchical wikis (directory structure)
  • Upload files
  • History (also as RSS/Atom changelog)
  • Access control lists
  • Support for multiple text engines (Creole, Markdown, Textile, ...)
  • Section editing for creole markup
  • Embedded LaTeX/Graphviz graphics
  • Syntax highlighting (embedded code blocks)
  • Image resizing, SVG to bitmap conversion
  • Auto-generated table of contents
  • Templates via include-tag
  • XML tag soup can be used to extend Wiki syntax
  • View pages as S5 presentation

Installation

First, you have to install the Gem dependencies via gem:

gem install creole
gem install gitrb
gem install mimemagic
gem install slim
gem install rack
gem install unicorn

Optional:

gem install rdiscount
gem install RedCloth
gem install maruku
gem install rubypants
gem install evaluator
gem install org-ruby
gem install yajl-ruby
gem install nokogiri

Then, run the program using the command in the application directory:

unicorn

Point your web browser at http://localhost:8080.

Git-Wiki automatically creates a repository in the directory ./.wiki. For production purposes, I recommend that you deploy the wiki with Unicorn. I tested other webservers like thin, rainbows, webrick and mongrel. Git-Wiki works with all of them thanks to rack.

Configuration

You might want to deploy the wiki on a server and want to tweak some settings. Just copy the default configuration config/config.yml.default to config/config.yml. You can specify a different configuration file via the environment variable WIKI_CONFIG.

export WIKI_CONFIG=/home/user/wiki_config.yml

Dependencies

Optional Dependencies

Dependencies for page rendering

At least one of these renderers should be installed:

Something went wrong with that request. Please try again.