Gollum is a
wiki software
Wiki software (also known as a wiki engine or a wiki application), is collaborative software that runs a wiki, which allows the users to create and collaboratively edit pages or entries via a web browser. A wiki system is usually a web application ...
using
git
Git () is a distributed version control system: tracking changes in any set of files, usually used for coordinating work among programmers collaboratively developing source code during software development. Its goals include speed, data in ...
as the back end storage mechanism, and written mostly in
Ruby
A ruby is a pinkish red to blood-red colored gemstone, a variety of the mineral corundum ( aluminium oxide). Ruby is one of the most popular traditional jewelry gems and is very durable. Other varieties of gem-quality corundum are called sa ...
. It started life as the wiki system used by the
GitHub
GitHub, Inc. () is an Internet hosting service for software development and version control using Git. It provides the distributed version control of Git plus access control, bug tracking, software feature requests, task management, continuous ...
web hosting system. Although the open source Gollum project and the software currently used to run GitHub wikis have diverged from one another, Gollum strives to maintain compatibility with the latter.
Formats supported
Gollum wikis are simply Git repositories that adhere to a specific format. Gollum pages may be written in a variety of formats including
Markdown
Markdown is a lightweight markup language for creating formatted text using a plain-text editor. John Gruber and Aaron Swartz created Markdown in 2004 as a markup language that is appealing to human readers in its source code form. Markdown is ...
,
AsciiDoc,
ReStructuredText
reStructuredText (RST, ReST, or reST) is a file format for textual data used primarily in the Python programming language community for technical documentation.
It is part of the Docutils project of the Python Doc-SIG (Documentation Special Inte ...
,
Creole and
MediaWiki
MediaWiki is a free and open-source wiki software. It is used on Wikipedia and almost all other Wikimedia websites, including Wiktionary, Wikimedia Commons and Wikidata; these sites define a large part of the requirement set for MediaWiki ...
markup.
[ linuxfr.org (2010/08/25), Gollum un wiki propulsé par gi]
/ref>
Features
* YAML Frontmatter for controlling per-page settings
* UML diagrams via PlantUML
PlantUML is an open-source tool allowing users to create diagrams from a plain text language. Besides various UML diagrams, PlantUML has support for various other software development related formats (such as Archimate, Block diagram, BPMN, C4, ...
* BibTeX
BibTeX is reference management software for formatting lists of references. The BibTeX tool is typically used together with the LaTeX document preparation system. Within the typesetting system, its name is styled as . The name is a portmanteau ...
and citation support (when using Pandoc
Pandoc is a free-software document converter, widely used as a writing tool (especially by scholars)- - - and as a basis for publishing workflows. It was created by John MacFarlane, a philosophy professor at the University of California, Berke ...
for rendering)
* Annotations using CriticMarkup
* Mathematics via MathJax
MathJax is a cross-browser JavaScript library that displays mathematical notation in web browsers, using MathML, LaTeX and ASCIIMathML markup. MathJax is released as open-source software under the Apache License.
The MathJax project started i ...
* Macros
* Redirects
* Support for Right-To-Left Languages
Editing
Editing the pages can be done via the provided web interface, via its API
An application programming interface (API) is a way for two or more computer programs to communicate with each other. It is a type of software interface, offering a service to other pieces of software. A document or standard that describes how ...
or with a text editor directly in the git repository.
See also
* ikiwiki
ikiwiki is a free and open-source wiki application, designed by Joey Hess. It is licensed under the terms of the GNU General Public License, version 2 or later. ikiwiki is written in Perl, although external plugins can be implemented in any lang ...
: Also uses a version control system to store pages
* Gitit (software)
Gitit (or darcsit) is a form of wiki software employing a distributed revision control system such as Git to manage the wiki history, and the Pandoc document conversion system to manage markup – permitting, among other things, the inclusion of La ...
: Git
Git () is a distributed version control system: tracking changes in any set of files, usually used for coordinating work among programmers collaboratively developing source code during software development. Its goals include speed, data in ...
-based wiki software with similar features
References
External links
*
Documentation
{{Microsoft FOSS
GitHub
Free wiki software
Free software programmed in Ruby
Microsoft free software
Software using the MIT license
2009 software