Difference between revisions of "Template:Github/doc"

From Lorekeeper Wiki
Jump to navigation Jump to search
Tag: 2017 source edit
Tag: 2017 source edit
Line 3: Line 3:
 
This template provides a link to a given github repo; by default, it points to a given user's fork of Lorekeeper and optionally to a given branch of it, but it can be pointed to other repos as convenient.
 
This template provides a link to a given github repo; by default, it points to a given user's fork of Lorekeeper and optionally to a given branch of it, but it can be pointed to other repos as convenient.
 
== Usage ==
 
== Usage ==
 +
The default use-- to point at a branch of Lorekeeper-- is as such:
 +
<pre>{{Github|user=|branch=}}</pre>
 +
It can also point to other repos as desired, and branches of them if need be.
 +
<pre>{{Github|user=|repo=}}</pre>
 +
=== Parameters ===
 +
{{Docparam|name=user|req=yes|desc=Github username.}}
 +
{{Docparam|name=branch|req=no|desc=Branch name.}}
 +
{{Docparam|name=repo|req=no|default=lorekeeper|desc=Github repo.}}
  
 
{{sandbox other||
 
{{sandbox other||

Revision as of 09:45, 11 June 2020

This template provides a link to a given github repo; by default, it points to a given user's fork of Lorekeeper and optionally to a given branch of it, but it can be pointed to other repos as convenient.

Usage

The default use-- to point at a branch of Lorekeeper-- is as such:

{{Github|user=|branch=}}

It can also point to other repos as desired, and branches of them if need be.

{{Github|user=|repo=}}

Parameters

Required
Github username.
Optional
Branch name.
Optional
(default: "lorekeeper")
Github repo.