1
0
mirror of https://github.com/dpc/tagwiki synced 2024-11-16 05:34:50 +00:00

Add docs - example wiki pages + help + docs

This commit is contained in:
Dawid Ciężarkiewicz 2020-05-12 23:53:46 -07:00
parent 70163f9cc7
commit 723d752bc0
4 changed files with 67 additions and 0 deletions

View File

@ -0,0 +1,8 @@
<!---
tagwiki-page-id: 1cffa9b42cfb2a28619deeeb58a01a7d
-->
# Welcome to Tagwiki!
This page contains no tags so it's a direct match for `/` and therefore a "main page".
Check [tagwiki help pages](/tagwiki/help) for more information.

17
docs/tagwiki-shortcuts.md Normal file
View File

@ -0,0 +1,17 @@
<!---
tagwiki-page-id: b1d3dcafcdcd33e04641a64978c68c31
-->
# #Tagwiki #shortcuts
Tagwiki can be used mouse-free.
Available shortcuts:
* `n` for new page
* `e` for editing current page
* `d` for delete
* `alt+/` to jump to the search box, enter to
* `ESC` for "going up" / "cancel"
* `j`, `k`, `h`, `l` to navigate links
* `alt+enter` or `ctrl+enter` to save

25
docs/tagwiki-tagging.md Normal file
View File

@ -0,0 +1,25 @@
<!---
tagwiki-page-id: 97cc6f1750fdc7722e036f1eea4fd129
-->
# #Tagwiki #tagging & links
Tag is any text starting with `#` and followed by letters, numbers, dashes and underscores.
Tags are automatically indexed. To link to other pages use normal markdown links referencing the tags used in the pages you want to reference.
Example:
`[All tagwiki help pages](/help/tagwiki)`
will produce:
[All tagwiki help pages](/help/tagwiki)
You can start your link with `/` to reference the global namespace, or without it, to narrow down current-page tags with more tags.
The order of tags in the link is significant, but not critical. The rule of thumb is: try to use the most important and general tags first. Tagwiki will automatically and gracefully handle stale, missing and incorrect tags, so as your pages evolve, all the links should degrade gracefully.
#help

View File

@ -0,0 +1,17 @@
<!---
-->
# Welcome to #Tagwiki
Tagwiki is a structure-free wiki, where everything is addressed by its tags.
Features:
* tag-based address
* markdown-based
* good mouse-free navigation support
Check [other help pages for more information](/tagwiki/help).
#introduction