Update details
This commit is contained in:
parent
dde702724d
commit
81f67689dd
1 changed files with 24 additions and 0 deletions
24
README.md
24
README.md
|
|
@ -2,3 +2,27 @@ GitSnax
|
|||
=======
|
||||
|
||||
GitSnax adds a #gitsnack parser function to MediaWiki which allows embedding raw files and gists from github.com
|
||||
|
||||
## Installation
|
||||
|
||||
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.
|
||||
|
||||
|
|
|
|||
Reference in a new issue