Ōlelo is a wiki that stores pages in a Git repository. See the demo installation at http:https://git.awiki.org/ or http:https://git-wiki.kicks-ass.org/.
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
First, you have to install the Gem dependencies via gem
:
gem install creole
gem install gitrb
gem install mimemagic
gem install haml
gem install rack
gem install nokogiri
gem install mongrel --source http:https://gems.rubyinstaller.org
gem install rdiscount
gem install RedCloth
gem install maruku
gem install rubypants
gem install evaluator
gem install org-ruby
gem install yajl-ruby
Then, run the program using the command:
rackup -smongrel -p4567
Point your web browser at http:https://localhost:4567.
Git-Wiki automatically creates a repository in the directory ./.wiki
.
For production purposes, I recommend that you deploy the wiki with Mongrel.
I tested other webservers like unicorn, thin and webrick.
Git-Wiki works with all of them thanks to rack.
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
- Pygments for syntax highlighting
- ImageMagick for image scaling and svg rendering
- RubyPants to fix punctuation
At least one of these renderers should be installed: