diff --git a/content/getting-started/wiki.md b/content/getting-started/wiki.md index 669c211..c643cb5 100644 --- a/content/getting-started/wiki.md +++ b/content/getting-started/wiki.md @@ -14,12 +14,15 @@ The user in these examples is *knut* the polar bear and its repository is *fooba ## Activation and Permissions To enable the Wiki for a project, visit the `Settings` page and activate `Enable Repository Wiki` in the `Advanced Section`. It will default to the build-in wiki which is described here, but you can as well add an URI to an external site the "Wiki" tab should link to (not part of this doc). -Be aware that the wiki, once enabled, is accessible for *everyone* who has `read` access your project - on public projects even unauthorized guests can access the wiki. It is **not** suitable for storing secrets (like passwords and so on). +Be aware that the wiki, once enabled, is accessible for *everyone* who has `read` access your project - on public projects even unauthorized guests can access the wiki. + +> **Warning** +> The wiki is *not* a suitable place for storing private information or secrets (like passwords). To edit the Wiki `write` permission to the project is required. ## Wiki structure -The Wiki is essentially a separate Git repo in your project with a predefined name like `.wiki.git`. +The Wiki is essentially a separate Git repo in your project with a predefined name in the form of `.wiki.git`. It consists of [Markdown](https://en.wikipedia.org/wiki/Markdown) files (file extension `.md`) and additional assets like images. No further style sheets are needed. The markdown files are automatically rendered according to the selected Codeberg theme. @@ -33,7 +36,6 @@ Using the web UI in your browser is currently limited to add/update/delete pages Wiki home page with edit buttons - ## Adding content via a local git client You can work with the Wiki repo as with any other Git repo on Codeberg, see our docs about managing a Git repo [via CLI](https://docs.codeberg.org/git/clone-commit-via-cli).