Difference between revisions of "Template:Github/doc"

From Lorekeeper Wiki
Jump to navigation Jump to search
Tag: 2017 source edit
Tag: 2017 source edit
 
(3 intermediate revisions by the same user not shown)
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 ===
 +
{| class="wikitable"
 +
! Parameter !! Required? !! Default !! Description
 +
|-
 +
| user || yes || || Github username.
 +
|-
 +
| branch || no || || Branch name.
 +
|-
 +
| repo || semi || lorekeeper || Github repo.
 +
|}
  
 
{{sandbox other||
 
{{sandbox other||

Latest revision as of 10:14, 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

Parameter Required? Default Description
user yes Github username.
branch no Branch name.
repo semi lorekeeper Github repo.