Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.28 KB

repo-settings.md

File metadata and controls

48 lines (32 loc) · 1.28 KB

Per-repo settings/metadata

You can set properties on any owner/repo by committing a file at either:

  • https://github.com/owner/repo/.ghuser.io.json, or
  • https://github.com/owner/repo/.github/ghuser.io.json.

Table of Contents

Avatar

{
  "_comment": "Repo metadata for ghuser.io. See https://github.com/ghuser-io/ghuser.io/blob/master/docs/repo-settings.md",
  "avatar_url": "https://cdn.jsdelivr.net/gh/ghuser-io/ghuser.io@f44119258dfeade99c800232044cf7c3e3a91982/docs/logo_square.png"
}

This avatar will be used on any ghuser-profile mentioning this repo:

screenshot

See this example.

Techs/Frameworks

{
  "_comment": "Repo metadata for ghuser.io. See https://github.com/ghuser-io/ghuser.io/blob/master/docs/repo-settings.md",
  "techs": ["React", "Node.js", "Reframe", "hapi", "Bootstrap", "Semantic UI", "AWS", "Ansible",
            "Travis CI"]
}

These techs will be shown on any ghuser-profile mentioning this repo:

screenshot

WARNING: Do not use this property for declaring programming languages. These are already automatically detected.

See this example.