From e7ffb01ba7bc8b019808c676a5c0cbd4c3828c02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dawid=20Ci=C4=99=C5=BCarkiewicz?= Date: Fri, 15 May 2020 23:49:21 -0700 Subject: [PATCH] Add more help pages --- README.md | 8 ++++++-- docs/journals-note-taking.md | 25 +++++++++++++++++++++++++ docs/tagwiki-shortcuts.md | 2 ++ docs/tagwiki-tagging.md | 2 ++ docs/welcome-to-tagwiki.md | 4 +++- 5 files changed, 38 insertions(+), 3 deletions(-) create mode 100644 docs/journals-note-taking.md diff --git a/README.md b/README.md index 95a6a69..8974775 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,13 @@ that I don't have to pre-plan or carefully maintain. * uses Markdown for content, * brutally simple, * fast, -* excelent support for keyboard navigation, +* excellent support for keyboard navigation, * keeps pages as markdown files in a directory, +* convenient logs/journals/note taking + +### How it looks + +![tagwiki screenshot](https://i.imgur.com/0UrHCoI.png) ### Under the hood @@ -44,7 +49,6 @@ that I don't have to pre-plan or carefully maintain. ### Feature ideas: -* "journal mode" - for easy note taking * support public-facing setups (authentication, permissions, and so on) ### Installing & running diff --git a/docs/journals-note-taking.md b/docs/journals-note-taking.md new file mode 100644 index 0000000..f9c391a --- /dev/null +++ b/docs/journals-note-taking.md @@ -0,0 +1,25 @@ + +# Journals & note taking + +One of the design goals for #tagwiki was good support for journals +and note taking. + +Any set of tags can be a journal. Let's say you would like +to take have a work related logs/journal. These can be just a lot +of pages sharing `mycompany` and `journal` tags. + +Just create a couple of first notes with these tags. Afterwards, you can easily add a note, +by going to `/mycompany/journal` page and pressing `n`. + +The new page editing screen will be pre-populated with the current tags, +so you can just type in your note and save it with `ctrl+enter`. + +In many desktop environments you can set up a global shortcut to open +http://localhost/mycompan/journal/?edit=id in your browser. This way you +have a convenient method to create a new note at any time. + +#tagwiki #help #journal \ No newline at end of file diff --git a/docs/tagwiki-shortcuts.md b/docs/tagwiki-shortcuts.md index 2941081..afcbe6a 100644 --- a/docs/tagwiki-shortcuts.md +++ b/docs/tagwiki-shortcuts.md @@ -1,5 +1,7 @@ # #Tagwiki #shortcuts diff --git a/docs/tagwiki-tagging.md b/docs/tagwiki-tagging.md index 727efdc..50d5907 100644 --- a/docs/tagwiki-tagging.md +++ b/docs/tagwiki-tagging.md @@ -1,5 +1,7 @@ # #Tagwiki #tagging & links diff --git a/docs/welcome-to-tagwiki.md b/docs/welcome-to-tagwiki.md index fc0a2ac..36eb04b 100644 --- a/docs/welcome-to-tagwiki.md +++ b/docs/welcome-to-tagwiki.md @@ -1,5 +1,7 @@ # Welcome to #Tagwiki