Template:Cite GitHub/doc

From ChewWiki
Revision as of 21:55, 9 September 2024 by Chew (talk | contribs) (add docs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Cite GitHub.

Use this to Cite GitHub.

TemplateData

Cites a GitHub commit or file.

Template parameters

ParameterDescriptionTypeStatus
URLurl

The URL to the resource.

Example
https://github.com/Chew/MLB-GameFeed-Bot/blob/875f62c510ba9703ccbe2d285d046930372203ba/src/main/java/pw/chew/mlb/MLBBot.java
URLrequired
Titletitle

The title of the file, commit, etc.

Example
MLBBot.java
Stringrequired
Authorauthor

The author of the commit, if applicable.

Stringoptional
Org/Userorg

Org/User of Repo

Example
The organization, or username, of the user/company who owns the repository linked.
Stringrequired
Repository Namerepo

The name of the repository being cited.

Example
chew.pw
Stringrequired
Typetype

The type of thing being cited. Currently just a commit or file.

Suggested values
commit file
Stringrequired
Commit Hashhash

The hash of the commit being referenced. Only required if the type is a commit.

Stringrequired
File Commitcommit

The commit hash of the file version being referenced. Only required if the specified type is a file.

Stringoptional
Retrieved Dateretrieved

The date the file was retrieved. Not necessary if referencing a hash.

Datesuggested