wiki.ohea.xyz/gollum
10
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

Revise description in readme.

Browse Source
This commit is contained in:
Tom Preston-Werner
2010-08-05 19:05:54 -06:00
parent ca8ab2f374
commit 8c09e26fc1
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+8 -6
View File
@@ -3,13 +3,15 @@ gollum -- A wiki built on top of Git
## DESCRIPTION ## DESCRIPTION
Gollum is a simple wiki built on top of Git that powers GitHub Wikis. Gollum Gollum is a simple wiki system built on top of Git that powers GitHub Wikis.
is designed so that you can create a compliant Git repository (known as a
Gollum repository) either by hand, by calling API methods, or via the web
interface.
We are making the source available so that you may test your wikis locally if Gollum wikis are simply Git repositories that adhere to a specific format.
you choose to edit them by hand. Gollum pages may be written in a variety of formats and can be edited in a
number of ways depending on your needs. You can edit your wiki locally:
* With your favorite text editor or IDE.
* With the built-in web interface.
* With the Gollum Ruby API.
Gollum follows the rules of [Semantic Versioning](http://semver.org/) and uses Gollum follows the rules of [Semantic Versioning](http://semver.org/) and uses
[TomDoc](http://tomdoc.org/) for inline documentation. [TomDoc](http://tomdoc.org/) for inline documentation.