Wiki with git backend
Ruby JavaScript
Switch branches/tags
Nothing to show
Pull request Compare This branch is 2 commits ahead, 666 commits behind minad:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
deps
doc
lib
plugins
static
test
tools
views
.gitignore
.gitmodules
README.markdown
Rakefile
config.ru

README.markdown

README

Git-Wiki is a wiki that stores pages in a Git repository.

See the demo installation at http://git.awiki.org/ or http://git-wiki.kicks-ass.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)
  • Plugin system
  • 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 haml
gem install rack
gem install nokogiri
gem install mongrel --source http://gems.rubyinstaller.org

# other rack-esi implementations should also work
# just try it
gem install minad-rack-esi

# this is a more current version of rack-cache with bugfixes
# TODO: replace this with official release when new version is released
gem install minad-rack-cache

Optional:

gem install rdiscount
gem install RedCloth
gem install maruku
gem install rubypants
gem install imaginator
gem install evaluator
gem install rack-embed
gem install org-ruby

Then, run the program using the command:

rackup -smongrel -p4567

Point your web browser at http://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.

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: