Skip to content

kuccello/git-wiki

 
 

Repository files navigation

README

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

Demo installation at http://git-wiki.kicks-ass.org/

Features

A lot of the features are implemented as plugins.

  • History
  • Show diffs
  • Edit page, upload files
  • Section editing
  • Plugin system
  • Multiple renderers
  • LaTeX/Graphviz
  • Syntax highlighting (embedded code blocks)
  • Image support, SVG support
  • Auto-generated table of contents
  • Templates
  • XML tags can be used to extend Wiki syntax

Installation

At first you have to install the gem dependencies via "gem".

gem sources -a http://gems.github.org/
gem install minad-creole
gem install minad-git
gem install minad-rack-esi
gem install rack-cache
gem install haml
gem install thin
gem install rack

Optional: gem install hpricot gem install rdiscount gem install RedCloth gem install maruku gem install rubypants gem install RMagick gem install minad-imaginator

Then run with ./run.ru -sthin -p4567 and. point your browser at http://localhost:4567. It automatically creates a repository in the directory '.wiki'.

Dependencies

Optional Dependencies

  • RubyPants to fix puncation
  • Pygments for syntax highlighting
  • imaginator for LaTeX/graphviz output (minad-imaginator gem from github)
  • hpricot for tags in the wikitext
  • RMagick for image scaling and svg rendering

Dependencies for page rendering

  • creole for creole wikitext rendering (minad-creole gem from github)
  • RDiscount for markdown rendering
  • RedCloth for textile rendering

At least one of the renderers should be installed.

About

Lightweight wiki with git backend

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published