Template:Cite GitHub/doc: Difference between revisions

From ChewWiki
Jump to navigation Jump to search
add docs
Tag: 2017 source edit
 
fix params
Tag: 2017 source edit
 
Line 51: Line 51:
"required": true
"required": true
},
},
"hash": {
"retrieved": {
"label": "Retrieved Date",
"description": "The date the file was retrieved. Not necessary if referencing a hash.",
"type": "date",
"suggested": true
},
"commit": {
"label": "Commit Hash",
"label": "Commit Hash",
"description": "The hash of the commit being referenced. Only required if the type is a commit.",
"description": "The hash of the commit being referenced. Only required if the type is a commit.",
Line 57: Line 63:
"required": true
"required": true
},
},
"commit": {
"date": {
"label": "File Commit",
"label": "Commit Date",
"description": "The commit hash of the file version being referenced. Only required if the specified type is a file.",
"description": "The day the commit was committed.",
"type": "string"
"type": "date"
},
"retrieved": {
"label": "Retrieved Date",
"description": "The date the file was retrieved. Not necessary if referencing a hash.",
"type": "date",
"suggested": true
}
}
},
},
Line 76: Line 76:
"repo",
"repo",
"type",
"type",
"hash",
"commit",
"commit",
"retrieved"
"retrieved",
"date"
],
],
"description": "Cites a GitHub commit or file."
"description": "Cites a GitHub commit or file."
}
}
</templatedata>
</templatedata>

Latest revision as of 21:44, 14 September 2024

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 Hashcommit

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

Stringrequired
Retrieved Dateretrieved

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

Datesuggested
Commit Datedate

The day the commit was committed.

Dateoptional