View source for Template:GitHub

{{#if: {{{1|}}} | {{#if:{{{5|}}}|[|}}https://github.com/{{{1|}}}{{#if:{{{2|}}}|/{{{2|}}}|}}{{#if:{{{3|}}}|{{#if:{{{4|}}}|/blob/{{{3|}}}/{{{4|}}}|/tree/{{{3|}}}}}|}} {{#if: {{{5|}}} | {{{5|}}}] | }} | }}<noinclude>

== Description ==

'''Template:{{PAGENAME}}'''

For quickly linking to repository pages or source files on GitHub.

== Usage ==

* <span style="font-family:monospace;font-size:14px;border:solid 2px;border-color:lightgray;font-weight:bold;"><nowiki>{{GitHub|name|[repo|[branch/tag/commit|[file]]]|[text]}}</nowiki></span>

=== Arguments ===

{| class="wikitable"
! Argument || Required || Description
|-
| name || {{status|check}} || User or organization name.
|-
| repo || || Repository name.
|-
| branch/tag/commit || || Branch name or tag/commit ID.
|-
| file || || Relative path to file.
|-
| text || || Alternate text to display.
|}

== Example ==

<blockquote>
{| class="wikitable"
! Description || Input || Output
|-
| Link to a user/organization page. || <nowiki>{{GitHub|arianne}}</nowiki> || {{GitHub|arianne}}
|-
| Link to a user/organization repository. || <nowiki>{{GitHub|arianne|stendhal}}</nowiki> || {{GitHub|arianne|stendhal}}
|-
| Link to a repository branch/tag/commit. || <nowiki>{{GitHub|arianne|stendhal|master}}</nowiki> || {{GitHub|arianne|stendhal|master}}
|-
| Link to a file in a repository branch/tag/commit. || <nowiki>{{GitHub|arianne|stendhal|cc06d43|data/sprites/outfit/dress/dress_005.png}}</nowiki> || {{GitHub|arianne|stendhal|cc06d43|data/sprites/outfit/dress/dress_005.png}}
|-
| Display alternate text (user/organization). || <nowiki>{{GitHub|arianne||||Arianne organization}}</nowiki> || {{GitHub|arianne||||Arianne organization}}
|-
| Display alternate text (repo). || <nowiki>{{GitHub|arianne|stendhal|||Stendhal repository}}</nowiki> || {{GitHub|arianne|stendhal|||Stendhal repository}}
|-
| Display alternate text (file). || <nowiki>{{GitHub|arianne|stendhal|cc06d43|data/sprites/outfit/dress/dress_005.png|dress_005}}</nowiki> || {{GitHub|arianne|stendhal|cc06d43|data/sprites/outfit/dress/dress_005.png|dress_005}}
|}
</blockquote>

== See Also ==

* [[Templates|List of templates]]
* [[:Category:RefactoringTemplates|List of refactoring templates]]


[[Category:Stendhal]]
[[Category:Development]]
[[Category:RefactoringTemplates]]