This repository has been archived on 2024-03-20. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
GitSnax/README.md

33 lines
926 B
Markdown

GitSnax
=======
GitSnax adds a #gitsnack parser function to MediaWiki which allows embedding raw files and gists from github.com into the wiki page.
## Installation
Download the code to your server:
cd /path/to/mediawiki/extensions
git clone https://gitlab.com/troyengel/GitSnax.git
Add the following code to your LocalSettings.php:
require_once "$IP/extensions/GitSnax/GitSnax.php";
## Usage
Find the 'Raw' link on the github.com file or gist you want to embed then
extract the URL part after the hostname to use in this hook like so:
Gist: (https://gist.githubusercontent.com/)
{{#gitsnack: gist | troyengel/c09459d43431ec98799b/raw/4bbab685fa4ab1391de3fcc8732718750a274340/arch-default-kernel}}
Code: (https://raw.githubusercontent.com/)
{{#gitsnack: code | troyengel/scripts/master/archmate.sh}}
## License
This code is licensed under the GNU GPL v2.0 or above, see COPYING for details.