wiki-sidebar #160

Merged
n merged 6 commits from wiki-sidebar into master 5 months ago
  1. 19
      content/getting-started/wiki.md

19
content/getting-started/wiki.md

@ -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
```
rwa marked this conversation as resolved
n commented 6 months ago
Review

I don't think this is accurate. You can edit it at https://codeberg.org/user/repo/wiki/_Sidebar.

I don't think this is accurate. You can edit it at `https://codeberg.org/user/repo/wiki/_Sidebar`.
Review

Thanks for the hint, i wasn't aware of that.

It's kinda unintuitive cause you can't navigate to the file via the pages dropdown. You need to manually enter the correct URI in your browser.

Might be worth an issue upstream to add a small "edit sidebar" button somewhere.

Thanks for the hint, i wasn't aware of that. It's kinda unintuitive cause you can't navigate to the file via the pages dropdown. You need to manually enter the correct URI in your browser. Might be worth an issue upstream to add a small "edit sidebar" button somewhere.
Review
upstream: https://github.com/go-gitea/gitea/issues/16655
Review

Thanks for the update. While i'm at it i'll add the footer thing too.

Thanks for the update. While i'm at it i'll add the footer thing too.
> 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…
Cancel
Save