4149d2dc809e42d995c384ad8c22df340935f97a
[wiki.git] / GeekiGeeki
1 <div style="float: right">GerryStich.jpg</div>
2
3 == Geeki Geeki, the stupid Wiki Wiki ==
4
5 GeekiGeeki is a minimalistic wiki with a [[http://git.or.cz/ | Git]]
6 backend, a high features/complexity ratio and a very clean syntax.
7 Check the EditingTips page for an idea the supported markup.
8
9 GeekiGeeki is FreeSoftware and written in Python and derives from
10 PikiWiki like MoinMoin.
11
12 For all your geeky wiki needs, GeekiGeeki is **the** stupid choice you can't avoid making!
13
14 == Features ==
15
16  * S^3: Simple, Small, Stupid
17  * Rich, clean markup syntax highly compatible with WikiCreole
18  * Git versioned storage backend
19  * Interfaces with Gitweb for history browsing, RSS...
20  * Consistent use of CSS for easy theming
21  * HTML pass-through for powerful formatting
22  * Pluggable macros
23  * Page includes (templates with parameters coming)
24  * Usable for blogging
25  * Directory listing
26  * [[Picture]] gallery
27  * Easy to interface with other SCMs through a glue script
28  * User accounts supported through HTTP basic auth done by web server
29  * Per-page ACLs
30  * Simple title and full text search
31  * Easy CGI installation (no WSGI, mod_python, FCGI...)
32  * Fast!
33  * Only 800 LOCs!
34  * GuruMeditation alerts :-)
35
36 == Download ==
37
38 ==== Releases ====
39
40 || 11-Dec-2008 || **v3.0** || http://www.codewiz.org/wikigit/geekigeeki.git?a=snapshot;h=v3.0;sf=tbz2 ||
41 || 23-Sep-2008 || **v2.0** || http://www.codewiz.org/wikigit/geekigeeki.git?a=snapshot;h=v2.0;sf=tbz2 ||
42
43
44 ==== Source ====
45
46 You can obtain the latest version -- actually ''any'' version -- through git:
47
48 {{{
49 git clone http://www.codewiz.org/~bernie/git/geekigeeki.git/
50 git clone git://www.codewiz.org/~bernie/geekigeeki.git/
51 }}}
52
53 ===== Revision history =====
54
55 Browse it online with GitWeb: http://www.codewiz.org/wikigit/geekigeeki.git
56
57 ===== Individual source files =====
58
59  * [[../wikidata/geekigeeki.py      | geekigeeki.py]]      -- The CGI itself
60  * [[../wikidata/geekigeeki.conf.py | geekigeeki.conf.py]] -- Sample site config
61  * [[../wikidata/geekigeeki.css     | geekigeeki.css]]     -- The stylesheet used at this site
62  * [[../wikidata/post_edit_hook.sh  | post_edit_hook.sh]]  -- Some glue to integrate with git
63  * [[../wikidata/wiki_apache.conf   | wiki_apache.conf]]   -- Sample conf file for Apache
64
65 == Installation ==
66
67 The easiest way is:
68
69  * clone the git repository anywhere you like
70  * edit **wiki_apache.conf** to adapt it to your system, and move or link it to your Apache configuration directory.
71  * customize the wiki through geekigeeki.conf.py
72  * create a git repository for your wiki:
73  {{{
74  mkdir data
75  cd data
76  git init --shared=group
77  chgrp -R apache .
78  }}}
79  * reload Apache
80
81 == Update procedure ==
82
83 If you cloned the repository as suggested, updating and downgrading is easy:
84
85 {{{
86 git pull
87 }}}
88
89 to switch to a different version of GeekiGeeki:
90
91 {{{
92 git checkout {tree-ish}
93 }}}
94
95 where '##{tree-ish}## could be a tag, a branch name, or a specific commit.
96
97 == Contributing ==
98
99 Please send your patches!  See the GeekiGeekiToDo list for ideas.
100
101 Bugfixes and cute hacks welcome.  BloatWare //will// be rejected: this is
102 a minimalistic wiki, damn'it!