From BC Wiki
Jump to: navigation, search

GitHub Wiki[edit]

Installing Gollum Locally[edit]

php dumpBackup.php --conf /var/www2/www-bsc/wiki/LocalSettings.php --full > dump.xml

sudo apt-get install php5-cli

curl -sS | php
php composer.phar install
curl -sS | sudo php -- --install-dir=/usr/local/bin --filename=composer

php convert.php --filename=mediawiki.xml --output=export --indexes=true
php convert.php --filename="../" --output=export --indexes=true

try this for mediawiki to gollum:

“The internal and external link formats that Gollum uses before WikiCloth parses the MediaWiki require a few changes, so the first script,, does this conversion automatically when given an input file. The second script,, takes one big MediaWiki page and splits it by headers, plus generates a TOC automatically on the home page.”

MediaWiki -- gem install wikicloth


"With wikis, you can write content just like everywhere else on GitHub. We use our open-source Markup library to convert different formats into HTML, so you can choose to write in Markdown, RST, Textile, or any other supported format when you craft wiki pages."

"Wikis can be edited directly on GitHub, or you can work with a text editor offline and simply push your changes. Wikis are collaborative by design. By default, every user can make changes to public wikis, but you can configure this to be enabled only for collaborators on your repository."

Adding and editing wiki pages locally

"The filename determines the title of your wiki page. You can use the \ character to escape special characters, such as spaces and punctuation, from the filename."

"If you create a file named _Footer. or _Sidebar., we'll use them to populate the footer and sidebar of your wiki, respectively."

Making GitHub More Open: Git-backed Wikis

"Each wiki is a Git repository, so you're able to push and pull them like anything else. Each wiki respects the same permissions as the source repository. Just add ".wiki" to any repository name in the URL, and you're ready to go."

"We're also releasing Gollum, the same ruby library that powers GitHub Wikis. Gollum provides a ruby API for accessing and modifying your content, and also includes a small Sinatra web server. Clone the demo wiki to see what's available, or check out the Gollum readme for more detailed information."

Personal Wiki using GitHub and Gollum on OS X

"Gollum is a Ruby-based wiki server that runs completely self-contained (you don't need to install PHP or a database) and is backed by Git. I use a Git repo cloned off a private GitHub repository for sync functionality."

"Gollum stores each wiki page in a separate file and uses a very simple markdown syntax for them all. There are no database files being shared or single-file indexes, so a conflict can only arise by editing the same wiki page, in approximately the same place. Otherwise Git will be able to merge the files and handle things without intervention. So far, I have not actually gotten a merge conflict that needed to be dealt with manually, so the windows seem small enough."

Federated Wikis[edit]