Use the integrated Wiki

It is a common practice to use wikis to collect knowledge and share information. STACKIT Git allows you to add a wiki to a repository for additional documentation.

The wiki is essentially a separate Git repository in your repository with a predefined name in the form of [your-repository-name].wiki.git.

Setting up the Wiki

To enable the wiki for a repository:

1. Open the Settings page
2. Open the Repository units section.
3. Click on Wiki
4. Activate Enable Repository Wiki.

Or ask your Git admin to do it.

Be aware that the wiki, once enabled, is accessible for everyone who has read access to your repository. On public repositories even unauthenticated guests can access the wiki.
The wiki is not a suitable place for storing private information or secrets (like passwords)!

Set the permissions:

1. Go to the Settings page.
2. If you want to give write access to everyone with an account, activate Allow anyone to edit the Wiki.
   Otherwise edit the Wiki write permissions as required.

Adding content

After you have enabled the wiki you are prompted to create the initial page Home.md.

You can add images to the root directory or a specific subfolder (likeassets or images) using your local Git client.

Adding a sidebar and a footer

You can add a custom sidebar and a footer that are shown on every page. The sidebar will be displayed to the right of the main content and the footer below.

To enable the sidebar, add a file named _Sidebar.md to your wiki. For a footer the file must be named _Footer.md. Both file types allow common Markdown syntax to adjust the presentation to your needs.