dallasgroot/Documentation
1
0
Fork 0
mirror of https://codeberg.org/Codeberg/Documentation.git synced 2026-06-16 05:13:54 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

complete usage of web & git cli for wiki updates

Browse source 
add screenshot of page management functions in web view
This commit is contained in:
René Wagner 2021-06-16 19:36:14 +02:00
parent 6b69ffc846
commit 68563215a4
No known key found for this signature in database
GPG key ID: 2B8BCD69606E7F19
2 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
assets/images/advanced/wiki/wiki_pageview.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 31 KiB

18
content/advanced/wiki.md
View file

@ -17,19 +17,23 @@ Be aware that the wiki, once enabled, is accessible for everyone who has `read`
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. It should consist of [Markdown](https://en.wikipedia.org/wiki/Markdown) files and additional assets like images. No further style sheets or similar is needed. The markdown files are rendered acording to the selected Codeberg theme.
The Wiki is essentially a separate Git repo in your project with a predefined name. It should consist of [Markdown](https://en.wikipedia.org/wiki/Markdown) files and additional assets like images. No further style sheets are neededm the markdown files are automatically rendered according to the selected Codeberg theme.
The name of the Wiki of a project is fixed as `<project name>.wiki.git`. The markdown files should use the extension `.md`.
The name of the Wiki of a project is fixed as `<project-name>.wiki.git`. The markdown files should use the extension `.md`.
## Adding content via web
After you have enable the Wiki you are asked to create the initial page `Home.md`.
Using the web UI in your browser is currently limited to add/update/delete pages, you can not manage assets like images this way.
![Wiki home page with edit buttons](assets/images/advanced/wiki/wiki_pageview.png "View of 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).
## Adding content via web
Using the web UI in your browser is currently limited to add/update/delete pages, you can not manage assets like images this way.
Editing locally allows you to use your favorite editor (preferably with markdown syntax check and highlighting) and manage additional assets like images.
> TODO: add screenshot and description
## Adding images
### Adding images
You could add images to the root directory or a specific subfolder (like `assets` or `images`) using your local git client.
A feasible workflow might look like this (replace `<user>` and `<project>` with your user and project name):