Project Details JSON Format

The following is the format used for the project details json, which is used for templates to understand more details of the project. All the following fields are optional and can be omitted. When creating your own templates, make sure to take into account that all these fields are optional and can return undefined.

name as (string or undefined): The name of the project, normally the name of the repository.

description as (string or undefined): A short description of the project, normally place right underneath the name of the project in the header.

favicon as (string or undefined): A link to a thumbnail for use of the web page's icon thumbnail.

keywords as (string[] or undefined): A list of keywords that are used for the meta data of each web page.

team as (string or undefined): The name of the team that worked on this project, omitting this will normally make the template use the author member instead.

author as (string or undefined): The name of the author(s) that worked on this project.

copyrightYear as (string or undefined): A string that contains the copyright year, which can look like "2020" or "2014 - 2020".

version as (string or undefined): The version of the project.

license as (string or undefined): The license of the project, normally a string that mentions and links to the license.