generated from JohnRillos/urbit_template
-
Notifications
You must be signed in to change notification settings - Fork 2
/
overview.udon
80 lines (48 loc) · 2.84 KB
/
overview.udon
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
;>
- Developer: ~rivmud-fabwen
- License: MIT
- Source repo: [https://github.com/JohnRillos/wiki](https://github.com/JohnRillos/wiki)
- Bug reports: [https://github.com/JohnRillos/wiki/issues](https://github.com/JohnRillos/wiki/issues)
%wiki is an app for creating, publishing, and contributing to wikis.
## Feature Requests
If you have a feature request or inquiry, please join the group `~rivmud-fabwen/wiki`
and post in the discussion chat, or DM ~rivmud-fabwen.
## Writing Wiki Pages
%wiki pages are written in Markdown. We try to support most common Markdown
syntax, but if something isn't working right let us know.
Like GitHub, %wiki also supports embedded [Mermaid flow charts](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams).
## Bulk Importing Markdown Files
You can import pages from a folder of .md files, by clicking "Import" on
your wiki's main page. This should be useful if you want to migrate an Obsidian
vault, or use a separate tool to write before publishing with %wiki.
## Privacy and User Permissions
On the Settings page, wiki admins can control who can view or edit the wiki.
### Visibility
Private wikis can only be seen or edited by the host. They can be used for
personal note-keeping, or writing drafts before making the wiki public later.
Public wikis can be viewed in a variety of ways, depending on these settings:
- "This wiki can be viewed as a website on the clearweb"
- Anyone with the URL can view it, as long as your Urbit is online and accessible from the internet.
- "This wiki can be viewed on Urbit"
- Any Urbit user can browse your wiki using their own ship's URL at `/wiki/~/p/~sampel-palnet/your-wiki-id/...`
- "Share this wiki on the global index so people can discover it"
- Info about your wiki will be spread to your pals, their pals, and so on.
- Your wiki will appear in a list of public wikis when someone opens the %wiki app.
- This option is only available if you _also_ enable "This wiki can be viewed on Urbit"
### Collaboration
You can configure your wiki so only you can edit it, any Urbit user can edit
it, or anybody on the internet can edit it. If you allow other users to edit,
they will be able to create and edit pages, but cannot change the wiki's
settings or delete pages.
## Revisions and Permalinks
You can view the page's edit history at `/wiki/my-wiki/my/page/~/history`.
The normal URL for the _latest_ version of a page is `/wiki/my-wiki/my/page`.
You can also permalink to specific versions of the page:
### By timestamp
Example: `/wiki/my-wiki/my/page?t=~2023.12.31..23.59.59`
- The date is @da notation in UTC time.
- The date does not need to be exact, this will always show you the page as it
existed at that timestamp.
### By version number
Example: `/wiki/my-wiki/my/page?v=3`
- The first version of the page is `0`.