h759bkyo4/Documentation
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

use "repository" instead of "project"

Browse source 
split shell example for cloning and adding an image
This commit is contained in:
René Wagner 2021-06-23 20:39:32 +02:00
parent 1029d9c370
commit ed179df4ef
No known key found for this signature in database
GPG key ID: 2B8BCD69606E7F19
1 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
content/getting-started/wiki.md
View file

@ -12,17 +12,16 @@ Codeberg allows you to add a Wiki to a repo for additional documentation.
The user in these examples is `knut` the polar bear and its repository is `foobar`.
## 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 unauthenticated guests can access the wiki.
To enable the Wiki for a repository, 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).
> **Warning**
> Be aware that the wiki, once enabled, is accessible for *everyone* who has `read` access 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).
To edit the Wiki `write` permission to the project is required.
To edit the Wiki `write` permission to the repository is required.
## Wiki structure
The Wiki is essentially a separate Git repo in your project with a predefined name in the form of `<your-projects-name>.wiki.git`.
The Wiki is essentially a separate Git repo in your repository with a predefined name in the form of `<your-repository-name>.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.
@ -39,6 +38,13 @@ Using the web UI in your browser is currently limited to add/update/delete pages
## 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).
```shell
git clone git@codeberg.org:knut/foobar.wiki.git
cd foobar.wiki.git
nano Home.md
git commit -am "create Home page"
```
Editing locally allows you to use your favorite editor (preferably with markdown syntax check and highlighting) and manage additional assets like images.
### Adding images
@ -47,8 +53,6 @@ You could add images to the root directory or a specific subfolder (like `assets
A feasible workflow might look like this:
```shell
git clone git@codeberg.org:knut/foobar.wiki.git
cd foobar.wiki.git
# create a subfolder for images
mkdir images
cd images