summaryrefslogtreecommitdiffstats
path: root/git-wiki.page
diff options
context:
space:
mode:
authorUser <bnewbold@daemon.robocracy.org>2010-01-25 17:28:27 +0000
committerUser <bnewbold@daemon.robocracy.org>2010-01-25 17:28:27 +0000
commit2be1fedb1ece4ef5ebb4427b2b3dcba6eac94277 (patch)
tree71422499690acbe0192c566f157acfab4602fe57 /git-wiki.page
parent914fa9c06cf296bc293f40d2a001e23c58eb2457 (diff)
downloadknowledge-2be1fedb1ece4ef5ebb4427b2b3dcba6eac94277.tar.gz
knowledge-2be1fedb1ece4ef5ebb4427b2b3dcba6eac94277.zip
renames
Diffstat (limited to 'git-wiki.page')
-rw-r--r--git-wiki.page68
1 files changed, 68 insertions, 0 deletions
diff --git a/git-wiki.page b/git-wiki.page
new file mode 100644
index 0000000..7538a43
--- /dev/null
+++ b/git-wiki.page
@@ -0,0 +1,68 @@
+---
+format: rst
+categories: projects
+toc: no
+...
+
+========
+Git Wiki
+========
+
+'Git Wiki' 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).
+
+__ http://djangoproject.com/
+__ http://git.cx
+
+It's implemenatation is '''incomplete'''. For personal use I ended up
+moving to gitit__; see http://know.bnewbold.net for an example.
+
+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
+
+__ http://know.bnewbold.net/software/latex
+.. [#] A python wrapper around LaTeX and pdflatex which does a great job
+ handling bibliographies, weird image formats, etc.
+
+Dependencies
+~~~~~~~~~~~~
+Pygments_
+ A python library for highlighting and/or typesetting source code. Used to
+ format diffs (aka, history of items)
+
+rubber_
+ Python script to make LaTeX compliation less painful.
+
+.. _Pygments: http://pygments.org/
+.. _rubber: http://www.sourceforge.net/rubber
+
+Development
+~~~~~~~~~~~
+The source tree can be browsed at `bn-project <http://git.bnewbold.net>`__;
+you'll have to look for an old branch or tag?
+
+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/
+* http://gitit.net/
+