blob: 0a8195e4883f1c92b32a63a52f05f28bc1e3dec8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
========
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
|
