wiki-sidebar (#160)
refers to Codeberg/Community#508 Co-authored-by: René Wagner <rwa@clttr.info> Reviewed-on: https://codeberg.org/Codeberg/Documentation/pulls/160 Co-authored-by: René W. <rwa@noreply.codeberg.org> Co-committed-by: René W. <rwa@noreply.codeberg.org>
This commit is contained in:
parent
8b2fced63f
commit
edae9a08e8
1 changed files with 19 additions and 0 deletions
|
@ -71,3 +71,22 @@ Now, you can reference the image in Markdown, like this:
|
|||
After saving your changes, the image should be visible.
|
||||
|
||||
> In contrast to embedding external images, images in Git are only rendered after saving the wiki or markdown file changes.
|
||||
|
||||
## Adding a sidebar and a footer
|
||||
To enhance the usability of your wiki 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, just add a filed 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.
|
||||
|
||||
Very basic example for a sidebar:
|
||||
```markdown
|
||||
- [[Home]]
|
||||
|
||||
### Content
|
||||
- [Page 1](Page-1)
|
||||
|
||||
> knuts wiki
|
||||
```
|
||||
|
||||
> To edit these special files in the Web UI you need to manually browse to the files, e.g. for our user *knut* and his *foobar* repo:
|
||||
> `https://codeberg.org/knut/foobar/wiki/_Sidebar`
|
||||
|
|
Loading…
Reference in a new issue