Repositories

It is very easy to add your own README files/templates to your Gogs instance without touching a single bit of Git history. You can replace/override core templates by creating a custom version.

Create a plain text file then move to directory custom/conf/readme and restart Gogs.

Also note that the README template supports four basic placeholders. Currently, you can use following placeholder for corresponding values of repository:

• {Name}: Repository name
• {Description}: Repository description
• {CloneURL.SSH}: Repository SSH clone address
• {CloneURL.HTTPS}: Repository HTTP/HTTPS clone address

It works like so:

repo name is: {Name}

{Description} You can get the development version of this repo via git clone {CloneURL.SSH} or git clone {CloneURL.HTTPS}

Note that if you have created file on your corresponding custom/conf/readme/My README, then use "My README".