Skip to content

Project

Defines project identity and source repository. This object is used for outputting metadata and prefixing resources.

Attributes

KeyDescriptionRequiredNotes
nameProject machine-readable nameYeskebab-case
titleHuman-readable project titleYesTitle Case
descriptionDescription of the projectYes
repoGithub repository link (HTTPs URL)Yes

Example

json
{
    "project": {
        "name": "my-website",
        "title": "My Website",
        "description": "My website is a bespoke sales platform for developers and designers.",
        "repo": "git@github.com:ainsley/my-website.git"
    }
}