Skip to content
This repository was archived by the owner on Oct 4, 2018. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
106 commits
Select commit Hold shift + click to select a range
ebf6365
fixed the order of javascripts - hotkeys now work
Sep 22, 2008
50913a0
merged in the sr master
Nov 1, 2008
87f60ef
Better hotkeys
geekq Oct 25, 2009
737a777
Merge
geekq Oct 25, 2009
ba9893c
Support for images
geekq Oct 25, 2009
6e57638
Make custom h1 possible
geekq Oct 25, 2009
3ed8b53
Merge branch 'master' of [email protected]:geekq/git-wiki
geekq Oct 25, 2009
cea0bb5
Update fork's README
geekq Oct 25, 2009
1ed9de0
More polite license
geekq Oct 25, 2009
93d2a97
Format README
geekq Oct 25, 2009
6ade2b4
CSS for navigation
geekq Oct 25, 2009
2ce8a59
CSS for print
geekq Oct 29, 2009
39cd5c5
Changed path to rackup and syntax for page names and link text
Dec 7, 2009
750bf01
more work on the names
Dec 15, 2009
5ed311c
new TODO
Dec 17, 2009
5317c2b
hu
Dec 17, 2009
0fa681b
new TODO
Dec 17, 2009
e0bf858
Merge branch 'master' of github.com:docunext/docu-not-git-wiki
Dec 17, 2009
c9036d9
mini
Dec 17, 2009
1b1f4e7
huh
Dec 17, 2009
6d81fa5
rack
Dec 17, 2009
9aae89d
huh
Dec 17, 2009
31464dc
rack
Dec 17, 2009
e6f8879
rack
Dec 17, 2009
dc182be
Merge branch 'localwork'
Dec 17, 2009
8f06488
mini
Dec 17, 2009
2bf4051
null
Dec 17, 2009
5730d21
setting up static files
Dec 20, 2009
554e52a
Merge branch 'master' of github.com:docunext/docu-not-git-wiki
Dec 20, 2009
9ffb821
jquery
Dec 20, 2009
1c35fcc
updated head template
Dec 20, 2009
81a0342
submods
Dec 20, 2009
09fedc6
jquery script ref in html head
Dec 20, 2009
6475d6f
Style: monospaced font
geekq Dec 28, 2009
7ef7caa
preparing for rack-rdiscount middleware
Jan 14, 2010
8d9ad93
Merge branch 'master' of github.com:docunext/docu-not-git-wiki
Jan 14, 2010
d6ce6e4
hmm
Jan 14, 2010
89442d0
ok
Jan 14, 2010
182c0c8
hmm
Jan 14, 2010
63e5cc6
Merge branch 'master' of github.com:docunext/docu-not-git-wiki
Jan 14, 2010
4fb9985
working on commits and history, commits works, history does not work …
Jan 27, 2010
5ccb1f7
Search for TODO entries
geekq Jan 31, 2010
e2cba93
Improve style: del, ul
geekq Jan 31, 2010
1955556
Fix page title injection
geekq Feb 5, 2010
08dffb3
Recognize TODOs in the content
geekq Feb 5, 2010
242464d
Sort pages list in case insensitive way
geekq Feb 5, 2010
1e5634a
Improve TODO list
geekq Feb 5, 2010
e3db0c2
Server pages in form, suitable for iPhone
geekq Feb 6, 2010
fadf845
Move task parsing to separate classes: Task, TaskList
geekq Feb 6, 2010
198d4d5
Raw view of text files via /raw/:page
geekq Feb 6, 2010
8a4e271
Recognize INCLUDE statements
geekq Feb 6, 2010
e18d457
Merge description and plans into README
geekq Feb 6, 2010
d87fd76
Plans and TODOs
geekq Feb 6, 2010
1ec01c4
Wiki task inclusion work
geekq Feb 6, 2010
c7c428b
Include task lists via http
geekq Feb 6, 2010
56e042b
Improve style
geekq Feb 6, 2010
b873e78
Recursive task inclusion (always on)
geekq Feb 6, 2010
4598213
Mark included tasks in special way
geekq Feb 6, 2010
46c5049
Turn off wiki words, edit link for included tasks
geekq Feb 6, 2010
e6484d8
Avoid endless recursion by saving a list of visited nodes
geekq Feb 7, 2010
8b8b152
Gather all tasks from all pages with `INCLUDE wiki:all`
geekq Feb 7, 2010
ab693f6
Switch recursion on or off with `recursion:true`
geekq Feb 7, 2010
96e249e
Enrich task attributes based on origin (referencing page)
geekq Feb 7, 2010
f822aba
adding css
Feb 8, 2010
6a6ba5d
css and styles
Feb 8, 2010
92f1b84
css
Feb 8, 2010
ac60380
Merge branch 'master' of github.com:docunext/docu-not-git-wiki
Feb 8, 2010
240d544
retaining some
Feb 8, 2010
4dba058
new
Feb 8, 2010
2fbfe7a
Revert "new"
Feb 8, 2010
0e3f1c8
Revert "Revert "new""
Feb 8, 2010
d47519e
why was this ever done to master?
Feb 8, 2010
5918b82
ugh, how did the merge on the branch get applied to master
Feb 8, 2010
2d1f599
new
Feb 8, 2010
385c3ea
back to normal, pretty much
Feb 8, 2010
ea70773
restoring gitmodules
Feb 8, 2010
a89761f
integrated some improvements from deadlyicon's branch: nested pages, …
Mar 22, 2010
df39a6b
new script for running ikis
Mar 22, 2010
fcd102d
debug ops and fixed post
Mar 24, 2010
55813d8
working on paths
Mar 24, 2010
c30c485
huh
Mar 24, 2010
a3acccc
huh
Mar 24, 2010
56e5b92
aok
Mar 24, 2010
ad07190
ok
Mar 24, 2010
f0d557e
organizing
Mar 24, 2010
04bc173
ok
Mar 24, 2010
3d39255
ok
Mar 24, 2010
df4c447
Ok
Mar 24, 2010
21f1d49
ok
Mar 24, 2010
f745422
ok
Mar 24, 2010
a6f018f
cleaning
Mar 24, 2010
9091640
cleann
Mar 24, 2010
7d49fc6
cleann
Mar 24, 2010
264307d
fixing templates
Mar 24, 2010
d3bfb2e
restored wiki link format, homepage
Mar 25, 2010
2bafa72
only the pagename, not the path
Mar 25, 2010
d15a652
net ssh to publish wiki
Mar 25, 2010
68888b8
finding relative paths
Mar 25, 2010
dfc0ad5
not using xsl yet
Mar 26, 2010
dfc882a
mini
Apr 28, 2010
3c762c1
allowing colons in wikilinks
Apr 29, 2010
983bd01
lame way to make breadcrumbs
Apr 29, 2010
8027b87
breadcrumbs and title
May 1, 2010
c6cad4a
better path management
May 14, 2010
e8b9d83
excludes
May 16, 2010
ab44601
reqs
Dec 26, 2011
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "public/s/js/jquery/plugins/jquery-form2xml"]
path = public/s/js/jquery/plugins/jquery-form2xml
url = [email protected]:docunext/jquery-form2xml.git
157 changes: 132 additions & 25 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,31 +1,133 @@
<<<<<<< .merge_file_YFuwYZ
git-wiki
========
=======
# git-wiki fork:

## added features
- nested pages
- double click page to edit
- instant preview while editing
- save and continue editing

## notable changes
- /pagename/edit is not /pagename?edit=1

## future features
- deleting pages
- restoring deleted pages
- moving pages
- shared sub-wiki's using submodules
- log / history / diff view

git-wiki: because who needs cool names when you use git?
========================================================
>>>>>>> .merge_file_6bMFZW

git-wiki is a wiki that relies on git to keep pages' history and
[Sinatra][] to serve them. This geek brain overlay system aims to
replace trac (wiki and ticket system), a CMS and sticky notes.

Features of this fork (by geekQ)
---------------------

### Support for images

You can add images to `/img` folder of your git repository. Subfolders
are also supported. At least gif, png and jpg supported - content type
is set automatically by Sinatra. You can reference the images then from
your wiki pages like `![My picture](/img/2009/my_picture.jpg)`

No web interface at this time - use `git commit`.


### Custom h1 header

If your wiki page contains a markdown h1 header, then this one is used
on the page. If not, then h1 is created out of the file name (as in
original git-wiki).


### Integrated TODO list(s)

Just write TODO or DONE at the beginning of a line with task you would
like to remember.


#### Inclusion

git-wiki is a wiki that relies on git to keep pages' history
and [Sinatra][] to serve them.
You can include tasks from other wiki pages. So it is possible to have
one separate page per project, e.g. ProjectGitWiki, ProjectWorkflow and
to aggregate all coding tasks on one, say ContextCoding page with
`INCLUDE project:GitWiki`, `INCLUDE project:Workflow`.

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.
You can also reference other contexts with `INCLUDE context:AtHome`.

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`.
Recursion can be turned on with `INCLUDE context:AtHome recursive:true`.
It is off by default.

You can also reference a source on the web. I prefer to manage my tasks
related to git-wiki development in this README file. So on my
ContextCoding page I have following reference: `INCLUDE
http://github.com/geekq/git-wiki/raw/master/README.markdown`

* DONE: include via http
* DONE: recursive inclusion
* DONE: mark included tasks in special way
* DONE: switch recursion on or off
* DONE: avoid endless recursion by saving a list of visited nodes
* TODO: include a task list filtered by tagged value, e.g. `TASKS context:home` should list all the tasks for the specified context.
* DONE: allow optional asterisk in front of TODO
* TODO: group included lists by project
* TODO: merge and resort tasks from subsequent INCLUDE statements
* DONE: gather all tasks from all pages with `INCLUDE wiki:all`
* TODO: gather all the remaining (not referenced) tasks into `task inventory` page

### No wiki words

For a hacker the wiki words is more a distraction than a help. Example:
if I mention ActiveRecord, than it should not link to the wiki article
ActiveRecord but appear as it is.

* DONE: do not rely on wiki words

### Other plans

* TODO: keyboard short cuts for edit and saving
* TODO: check dead links
* TODO: search engine
* IDEA: presentation system - markdown + my S5 alternative
* IDEA: support for attachments
* IDEA: support for deeper Wiki page folder structure
* IDEA: support for special programmed pages - via haml or liquid template engine

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:
The following [gems][] are required to run git-wiki:

- [Sinatra][]
- [mojombo-grit][]
- [HAML][]
- [RDiscount][]
- [RestClient][]

Run with `mkdir ~/wiki && (cd ~/wiki && git init) && ./run.ru -sthin -p4567`
and point your browser at <http://0.0.0.0:4567/>. Enjoy!
## Setup:
`mkdir ~/wiki && (cd ~/wiki && git init)` `./run.ru -sthin -p4567`

then just point your browser at <http://0.0.0.0:4567/> and you're done. Enjoy!

<<<<<<< .merge_file_YFuwYZ
=======
## Setup:
`mkdir ~/wiki && (cd ~/wiki && git init)` `./run.ru -sthin -p4567`

then just point your browser at <http://0.0.0.0:4567/> and you're done. Enjoy!

>>>>>>> .merge_file_6bMFZW
### Note:
if you're using passenger you'll want to symlink git_wiki/public into the repo's root directory

See also
--------
Expand All @@ -43,6 +145,7 @@ See also
[mojombo-grit]: http://github.com/mojombo/grit
[HAML]: http://haml.hamptoncatlin.com
[RDiscount]: http://github.com/rtomayko/rdiscount
[RestClient]: http://github.com/archiloque/rest-client
[tip]: http://wiki.infogami.com/using_lynx_&_vim_with_infogami
[WiGit]: http://el-tramo.be/software/wigit
[ikiwiki]: http://ikiwiki.info
Expand Down Expand Up @@ -84,17 +187,21 @@ then sync your changes back when you're done.</p>
Git is the next Unix</a></cite></p>
</blockquote>

Licence
-------
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004

Copyright (C) 2008 Simon Rozet <[email protected]>
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.
MIT license
-----------
Copyright (c) 2009 Vladimir Dobriakov, [email protected]

Copyright (c) Simon Rozet

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

4 changes: 4 additions & 0 deletions config.ru
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
require "rubygems"
require File.dirname(__FILE__) + "/git-wiki"

run GitWiki.new(File.expand_path("~/wiki"), ".markdown", "Home")
Loading