https://github.com/sr/git-wiki

A quick & dirty git-powered Sinatra wiki
https://github.com/sr/git-wiki

Last synced: 3 months ago
JSON representation

A quick & dirty git-powered Sinatra wiki

• Host: GitHub
• URL: https://github.com/sr/git-wiki
• Owner: sr
• Archived: true
• Created: 2008-01-29T20:39:42.000Z (almost 17 years ago)
• Default Branch: master
• Last Pushed: 2016-06-08T22:22:28.000Z (over 8 years ago)
• Last Synced: 2024-07-17T09:55:35.436Z (4 months ago)
• Language: Ruby
• Homepage: http://atonie.org/2008/02/git-wiki
• Size: 2.24 MB
• Stars: 532
• Watchers: 21
• Forks: 232
• Open Issues: 8
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
git-wiki: because who needs cool names when you use git?

========================================================

git-wiki is a wiki that relies on git to keep pages' history

and [Sinatra][] to serve them.

I wrote git-wiki as a quick and dirty hack, mostly to play with Sinatra.

It turned out that Sinatra is an awesome little web framework and that this

hack isn't as useless as I first though since I now use it daily.

However, it is definitely not feature rich and will probably never be because

I mostly use it as a web frontend for `git`, `ls` and `vim`.

If you want history, search, etc. you should look at other people's [forks][],

especially [al3x][]'s one.

Install

-------

The fellowing [gems][] are required to run git-wiki:

- [Sinatra][]

- [mojombo-grit][]

- [HAML][]

- [RDiscount][]

Run with `mkdir ~/wiki && (cd ~/wiki && git init) && ./run.ru -sthin -p4567`

and point your browser at . Enjoy!

See also

--------

- [How to use vim to edit <textarea> in lynx][tip]

- [WiGit][] think git-wiki except implemented in PHP

- [ikiwiki][] is a wiki compiler supporting git

  [Sinatra]: http://www.sinatrarb.com

  [GitHub]: http://github.com/sr/git-wiki

  [forks]: http://github.com/sr/git-wiki/network

  [al3x]: http://github.com/al3x/git-wiki

  [gems]: http://www.rubygems.org/

  [mojombo-grit]: http://github.com/mojombo/grit

  [HAML]: http://haml.hamptoncatlin.com

  [RDiscount]: http://github.com/rtomayko/rdiscount

  [tip]: http://wiki.infogami.com/using_lynx_&_vim_with_infogami

  [WiGit]: http://el-tramo.be/software/wigit

  [ikiwiki]: http://ikiwiki.info

Quotes

------



[...] the first wiki engine I'd consider worth using for my own projects.





Steve Dekorte







Oh, it looks like Git Wiki

may be the starting point for what I need...



Tom Morris on "How to build the perfect wiki"





What makes git-wiki so cool is because it is backed by a git store,

you can clone your wiki just like you could any other git repository.

I’ve always wanted a wiki that I could a.) pull offline when I didn’t

have access to the Internets and b.) edit (perhaps in bulk)

in my favorite text editor. git-wiki allows both.



Cloning your wiki





Numerous people have written diff and merge systems for wikis;

TWiki even uses RCS. If they used git instead, the repository would be tiny, and

you could make a personal copy of the entire wiki to take on the plane with you,

then sync your changes back when you're done.



Git is the next Unix



Licence

-------

               DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE

                       Version 2, December 2004

    Copyright (C) 2008 Simon Rozet 

    Everyone is permitted to copy and distribute verbatim or modified

    copies of this license document, and changing it is allowed as long

    as the name is changed.

               DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE

      TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

     0. You just DO WHAT THE FUCK YOU WANT TO.