Template:GitHub

From HandWiki
Revision as of 12:04, 27 December 2016 by imported>Jworkorg (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Usage

{{GitHub
| org    =
| repo   =
| tag    =
| path   =
| source =
| commit =
| issue  =
| pr     =
| label  =
}}

Examples

Use path to link to a file off the repository root:

{{GitHub|path=WELCOME.md}}

on GitHub

Use source to link to a source file within the repository's src/main/java subtree:

{{GitHub|source=net/imagej/ImageJ.java}}

on GitHub

Use org and repo to link to a different repository than imagej/imagej:

{{GitHub|org=fiji|repo=TrackMate|path=README.md}}

on GitHub

You can give just a repo (or just an org), and it will be used for both org and repo:

{{GitHub|repo=fiji|path=plugins/Examples/Fiji_Cube.ijm}}

on GitHub

If you give neither a path nor a source then it links to the repository as a whole:

{{GitHub|repo=fiji}}

on GitHub

Use tag to specify a tag (rather than master):

{{GitHub|tag=imagej-2.0.0-beta-7.9|path=app/src/test/java/imagej/debug/TypeHierarchy.java}}

on GitHub

Specifying tag alone links to the tag description:

{{GitHub|tag=imagej-2.0.0-rc-44}}

on GitHub

Use commit to specify a commit hash:

{{GitHub|commit=7a10880d485a13fc449d84c7e2eca3e1481064ee|label=imagej@7a10880d}}

imagej@7a10880d

Use issue or pr to specify an issue or PR number:

{{GitHub|issue=83|label=imagej#83}}
{{GitHub|pr=88|label=imagej#88}}

imagej#83 imagej#88

Use label to override the label:

{{GitHub|repo=fiji|path=plugins/Examples/Fiji_Logo_3D.js|label=Fiji... in 3D!}}

Fiji... in 3D!