man.sr.ht/index.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

---
title: man.sr.ht docs
---

[man.sr.ht](https://man.sr.ht/) is a git-powered wiki that can host
documentation for your projects. Click "create wiki" at the bottom of any page
to get started (you will have to log in first).

## Repository structure

Each repository should be laid out with files and directories you want
to serve in your wiki. Markdown files (`*.md`) will be
compiled to HTML with the same Markdown rules that are [supported on the rest of
the site](/markdown). Each page will be made available at the URL of the path to
the file, except for `index.md` which is also shown at the top-level of each
directory. Other kinds of files (html, images, etc) will not be served.

## Frontmatter

You may optionally begin a file with this pattern:

```
---
# YAML goes here
---
```

To add some extra metadata to your pages. The currently supported properties
are:

- **title**: set the article title
- **toc**: set to false to disable the table of contents

## Publishing your changes

Publishing your changes is as easy as committing them and pushing them
upstream. You can collaborate with others on your wiki the same way you
do on your git.sr.ht projects - a mailing list on lists.sr.ht or
any other approach that you like.

## Settings

Click "manage your wiki" (you will need to be logged in and viewing the wiki you
want to manage) to access wiki settings.

### Visiblity

Visibility of the wiki is managed separately to the backing git repo. This
allows you to create private repos with publically accessible wikis. Wikis that
are public and unlisted can be viewed by any user regardless of if they are
logged in. Wikis that are private can only be viewed by the owner.

### Delete

You can delete your wiki from this page. This operation cannot be undone. You
may optionally delete the backing repo, but be aware that that too cannot be
undone.