summaryrefslogtreecommitdiffstats
path: root/Git Wiki.page
diff options
context:
space:
mode:
authorUser <bnewbold@daemon.robocracy.org>2009-10-13 02:52:09 +0000
committerUser <bnewbold@daemon.robocracy.org>2009-10-13 02:52:09 +0000
commitf61026119df4700f69eb73e95620bc5928ca0fcb (patch)
treef17127cff9fec40f4207d9fa449b9692644ce6db /Git Wiki.page
parent9d431740a3e6a7caa09a57504856b5d1a4710a14 (diff)
downloadknowledge-f61026119df4700f69eb73e95620bc5928ca0fcb.tar.gz
knowledge-f61026119df4700f69eb73e95620bc5928ca0fcb.zip
Grand rename for gitit transfer
Diffstat (limited to 'Git Wiki.page')
-rw-r--r--Git Wiki.page57
1 files changed, 57 insertions, 0 deletions
diff --git a/Git Wiki.page b/Git Wiki.page
new file mode 100644
index 0000000..2c33c55
--- /dev/null
+++ b/Git Wiki.page
@@ -0,0 +1,57 @@
+========
+Git Wiki
+========
+
+`Git Wiki`__ is what you're doing right now! It is a django__ app which
+stores a hierarchy of articles/items in a git__ repository; each item
+is formated in `reStructured Text`__, which can be reinterpreted into
+XHTML or LateX (and thus a pdf document).
+
+__ /k/gitwiki/
+__ http://djangoproject.com/
+__ http://git.cx
+__ /k/restructuredtext/
+
+Features
+~~~~~~~~
+Full File History
+ Because all files are stored in a repository all changes are tracked
+ and can be reverted. It could be interesting to watch the evolution
+ of a larger or controversial item.
+PDF Output
+ Using a combination of `LaTeX`__ and rubber [#]_, portable document
+ files can be generated on the fly (with figures etc included)
+LaTeX Math in (X)HTML
+ When rendering to (X)HTML LaTeX math sections are rendered to png
+ and inserted as images
+
+__ /k/latex/
+.. [#] A python wrapper around LaTeX and pdflatex which does a great job
+ handling bibliographies, weird image formats, etc.
+
+Dependencies
+~~~~~~~~~~~~
+''(hey, everybody's got 'em)''
+
+Pygments_
+ A python library for highlighting and/or typesetting source code. Used to
+ format diffs (aka, history of items)
+
+.. _Pygments: http://pygments.org/
+
+Development
+~~~~~~~~~~~
+Git Wiki is under heavy development. The source tree can be browsed at `/code/bn-project </code/bn-project/>`__.
+
+To Do
+-----
+* implement per-section commentary
+* possibly implement aafigure ascii->svg plugin for docutils
+* possibly implement auto linking for CamelCase text (probably not)
+* implement grouping many articles into single pdf/book automagicly
+* possibly implement web-based editing/item creation
+
+Similar Projects
+~~~~~~~~~~~~~~~~
+* http://spu.tnik.org/
+