diff --git a/docs/tagwiki-main-page.md b/docs/tagwiki-main-page.md new file mode 100644 index 0000000..0d1bde8 --- /dev/null +++ b/docs/tagwiki-main-page.md @@ -0,0 +1,8 @@ + +# 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. diff --git a/docs/tagwiki-shortcuts.md b/docs/tagwiki-shortcuts.md new file mode 100644 index 0000000..a9b9e5a --- /dev/null +++ b/docs/tagwiki-shortcuts.md @@ -0,0 +1,17 @@ + +# #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 \ No newline at end of file diff --git a/docs/tagwiki-tagging.md b/docs/tagwiki-tagging.md new file mode 100644 index 0000000..727efdc --- /dev/null +++ b/docs/tagwiki-tagging.md @@ -0,0 +1,25 @@ + +# #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 \ No newline at end of file diff --git a/docs/welcome-to-tagwiki.md b/docs/welcome-to-tagwiki.md new file mode 100644 index 0000000..fc0a2ac --- /dev/null +++ b/docs/welcome-to-tagwiki.md @@ -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 \ No newline at end of file