Support Center & Knowledge base

Edit on Github

A practical feature is the ability to go directly from a page in the documentation and make changes on GitHub. Doing so requires the linked repository to have the repository url defined in its base

How to enable “Edit on Github” for your repository

To enable support for “Edit on Github” button on a page, the top level in that repositories Documentation-folder needs to have a reference to the repository in the front matter.

Do not include a trailing slash at the end of the repository URL.

An example of front-matter with repository set:


All sub-articles will use this repository as the base for the links generated to edit files on GitHub.

If no repository is defined

If there isn’t a repository front matter defined no edit-button will be shown.