feat: docs wip, circular dependency to solve...

This commit is contained in:
Weihua Lu
2021-05-13 17:56:06 +08:00
parent 84cfe572f5
commit 116d7574b1
6 changed files with 1824 additions and 1666 deletions

View File

@@ -79,7 +79,7 @@
(svg/horizontal-dots nil)])
(->>
[(when-not (util/mobile?)
{:title (t :help/toggle-right-sidebar)
{:title (t :shortcut.ui/toggle-right-sidebar)
:options {:on-click state/toggle-sidebar-open?!}})
(when current-repo

View File

@@ -234,22 +234,22 @@
[:th (t :help/shortcut)]]]
[:tbody
[:tr [:td (t :shortcut.editor/indent)] [:td "Tab"]]
[:tr [:td (t :help/unindent-block)] [:td "Shift-Tab"]]
[:tr [:td (t :help/move-block-up)] [:td (util/->platform-shortcut "Alt-Shift-Up")]]
[:tr [:td (t :help/move-block-down)] [:td (util/->platform-shortcut "Alt-Shift-Down")]]
[:tr [:td (t :shortcut.editor/outdent)] [:td "Shift-Tab"]]
[:tr [:td (t :shortcut.editor/move-block-up)] [:td (util/->platform-shortcut "Alt-Shift-Up")]]
[:tr [:td (t :shortcut.editor/move-block-down)] [:td (util/->platform-shortcut "Alt-Shift-Down")]]
[:tr [:td (t :help/create-new-block)] [:td "Enter"]]
[:tr [:td (t :help/new-line-in-block)] [:td "Shift-Enter"]]
[:tr [:td (t :shortcut.editor/new-line)] [:td "Shift-Enter"]]
[:tr [:td (t :undo)] [:td (util/->platform-shortcut "Ctrl-z")]]
[:tr [:td (t :redo)] [:td (util/->platform-shortcut "Ctrl-y")]]
[:tr [:td (t :help/zoom-in)] [:td (util/->platform-shortcut (if util/mac? "Cmd-." "Alt-Right"))]]
[:tr [:td (t :help/zoom-out)] [:td (util/->platform-shortcut (if util/mac? "Cmd-," "Alt-left"))]]
[:tr [:td (t :help/follow-link-under-cursor)] [:td (util/->platform-shortcut "Ctrl-o")]]
[:tr [:td (t :help/open-link-in-sidebar)] [:td (util/->platform-shortcut "Ctrl-shift-o")]]
[:tr [:td (t :expand)] [:td (util/->platform-shortcut "Ctrl-Down")]]
[:tr [:td (t :shortcut.editor/zoom-out)] [:td (util/->platform-shortcut (if util/mac? "Cmd-," "Alt-left"))]]
[:tr [:td (t :shortcut.editor/follow-link)] [:td (util/->platform-shortcut "Ctrl-o")]]
[:tr [:td (t :shortcut.editor/open-link-in-sidebar)] [:td (util/->platform-shortcut "Ctrl-shift-o")]]
[:tr [:td (t :shortcut.editor/expand-block-children)] [:td (util/->platform-shortcut "Ctrl-Down")]]
[:tr [:td (t :collapse)] [:td (util/->platform-shortcut "Ctrl-Up")]]
[:tr [:td (t :select-block-above)] [:td "Shift-Up"]]
[:tr [:td (t :select-block-below)] [:td "Shift-Down"]]
[:tr [:td (t :select-all-blocks)] [:td (util/->platform-shortcut "Ctrl-Shift-a")]]]]
[:tr [:td (t :shortcut.editor/select-block-up)] [:td "Shift-Up"]]
[:tr [:td (t :shortcut.editor/select-block-down)] [:td "Shift-Down"]]
[:tr [:td (t :shortcut.editor/select-all-blocks)] [:td (util/->platform-shortcut "Ctrl-Shift-a")]]]]
[:table
[:thead
[:tr
@@ -257,19 +257,19 @@
[:th (t :help/shortcut)]]]
[:tbody
[:tr [:td (t :help/toggle)] [:td "?"]]
[:tr [:td (t :help/git-commit-message)] [:td "c"]]
[:tr [:td (t :help/full-text-search)] [:td (util/->platform-shortcut "Ctrl-u")]]
[:tr [:td (t :help/page-search)] [:td (util/->platform-shortcut "Ctrl-Shift-u")]]
[:tr [:td (t :help/open-link-in-sidebar)] [:td "Shift-Click"]]
[:tr [:td (t :shortcut.git/commit)] [:td "c"]]
[:tr [:td (t :shortcut.go/search)] [:td (util/->platform-shortcut "Ctrl-u")]]
[:tr [:td (t :shortcut.go/search-in-page)] [:td (util/->platform-shortcut "Ctrl-Shift-u")]]
[:tr [:td (t :shortcut.editor/open-link-in-sidebar)] [:td "Shift-Click"]]
[:tr [:td (t :help/context-menu)] [:td "Right Click"]]
[:tr [:td (t :help/fold-unfold)] [:td "Tab"]]
[:tr [:td (t :help/toggle-contents)] [:td "t c"]]
[:tr [:td (t :help/toggle-doc-mode)] [:td "t d"]]
[:tr [:td (t :help/toggle-theme)] [:td "t t"]]
[:tr [:td (t :help/toggle-right-sidebar)] [:td "t r"]]
[:tr [:td (t :help/toggle-settings)] [:td "t s"]]
[:tr [:td (t :help/toggle-insert-new-block)] [:td "t e"]]
[:tr [:td (t :help/jump-to-journals)] [:td (if util/mac? "Cmd-j" "Alt-j")]]]]
[:tr [:td (t :shortcut.ui/toggle-contents)] [:td "t c"]]
[:tr [:td (t :shortcut.ui/toggle-document-mode)] [:td "t d"]]
[:tr [:td (t :shortcut.ui/toggle-theme)] [:td "t t"]]
[:tr [:td (t :shortcut.ui/toggle-right-sidebar)] [:td "t r"]]
[:tr [:td (t :shortcut.ui/toggle-settings)] [:td "t s"]]
[:tr [:td (t :shortcut.ui/toggle-new-block)] [:td "t e"]]
[:tr [:td (t :shortcut.go/journals)] [:td (if util/mac? "Cmd-j" "Alt-j")]]]]
[:table
[:thead
[:tr

View File

@@ -40,7 +40,10 @@
[:tr [:td (t :help/reference-autocomplete)] [:td "[[]]"]]
[:tr [:td (t :help/block-reference)] [:td "(())"]]]]
(shortcut-table :shortcut.category/basics)
(shortcut-table :shortcut.category/navigating)
(shortcut-table :shortcut.category/block-editing)
(shortcut-table :shortcut.category/block-command-editing)
(shortcut-table :shortcut.category/block-selection)
#_
[:table
[:thead
@@ -49,22 +52,22 @@
[:th (t :help/shortcut)]]]
[:tbody
[:tr [:td (t :shortcut.editor/indent)] [:td "Tab"]]
[:tr [:td (t :help/unindent-block)] [:td "Shift-Tab"]]
[:tr [:td (t :help/move-block-up)] [:td (util/->platform-shortcut "Alt-Shift-Up")]]
[:tr [:td (t :help/move-block-down)] [:td (util/->platform-shortcut "Alt-Shift-Down")]]
[:tr [:td (t :shortcut.editor/outdent)] [:td "Shift-Tab"]]
[:tr [:td (t :shortcut.editor/move-block-up)] [:td (util/->platform-shortcut "Alt-Shift-Up")]]
[:tr [:td (t :shortcut.editor/move-block-down)] [:td (util/->platform-shortcut "Alt-Shift-Down")]]
[:tr [:td (t :help/create-new-block)] [:td "Enter"]]
[:tr [:td (t :help/new-line-in-block)] [:td "Shift-Enter"]]
[:tr [:td (t :shortcut.editor/new-line)] [:td "Shift-Enter"]]
[:tr [:td (t :undo)] [:td (util/->platform-shortcut "Ctrl-z")]]
[:tr [:td (t :redo)] [:td (util/->platform-shortcut "Ctrl-y")]]
[:tr [:td (t :help/zoom-in)] [:td (util/->platform-shortcut (if util/mac? "Cmd-." "Alt-Right"))]]
[:tr [:td (t :help/zoom-out)] [:td (util/->platform-shortcut (if util/mac? "Cmd-," "Alt-left"))]]
[:tr [:td (t :help/follow-link-under-cursor)] [:td (util/->platform-shortcut "Ctrl-o")]]
[:tr [:td (t :help/open-link-in-sidebar)] [:td (util/->platform-shortcut "Ctrl-shift-o")]]
[:tr [:td (t :expand)] [:td (util/->platform-shortcut "Ctrl-Down")]]
[:tr [:td (t :shortcut.editor/zoom-out)] [:td (util/->platform-shortcut (if util/mac? "Cmd-," "Alt-left"))]]
[:tr [:td (t :shortcut.editor/follow-link)] [:td (util/->platform-shortcut "Ctrl-o")]]
[:tr [:td (t :shortcut.editor/open-link-in-sidebar)] [:td (util/->platform-shortcut "Ctrl-shift-o")]]
[:tr [:td (t :shortcut.editor/expand-block-children)] [:td (util/->platform-shortcut "Ctrl-Down")]]
[:tr [:td (t :collapse)] [:td (util/->platform-shortcut "Ctrl-Up")]]
[:tr [:td (t :select-block-above)] [:td "Shift-Up"]]
[:tr [:td (t :select-block-below)] [:td "Shift-Down"]]
[:tr [:td (t :select-all-blocks)] [:td (util/->platform-shortcut "Ctrl-Shift-a")]]]]
[:tr [:td (t :shortcut.editor/select-block-up)] [:td "Shift-Up"]]
[:tr [:td (t :shortcut.editor/select-block-down)] [:td "Shift-Down"]]
[:tr [:td (t :shortcut.editor/select-all-blocks)] [:td (util/->platform-shortcut "Ctrl-Shift-a")]]]]
[:table
[:thead
[:tr
@@ -72,23 +75,28 @@
[:th (t :help/shortcut)]]]
[:tbody
[:tr [:td (t :help/toggle)] [:td "?"]]
[:tr [:td (t :help/git-commit-message)] [:td "c"]]
[:tr [:td (t :help/full-text-search)] [:td (util/->platform-shortcut "Ctrl-u")]]
[:tr [:td (t :help/page-search)] [:td (util/->platform-shortcut "Ctrl-Shift-u")]]
[:tr [:td (t :help/open-link-in-sidebar)] [:td "Shift-Click"]]
[:tr [:td (t :help/context-menu)] [:td "Right Click"]]
[:tr [:td (t :shortcut.git/commit)] [:td "c"]]
[:tr [:td (t :shortcut.go/search)] [:td (util/->platform-shortcut "Ctrl-u")]]
[:tr [:td (t :shortcut.go/search-in-page)] [:td (util/->platform-shortcut "Ctrl-Shift-u")]]
[:tr [:td (t :help/fold-unfold)] [:td "Tab"]]
[:tr [:td (t :help/toggle-contents)] [:td "t c"]]
[:tr [:td (t :help/toggle-doc-mode)] [:td "t d"]]
[:tr [:td (t :help/toggle-theme)] [:td "t t"]]
[:tr [:td (t :help/toggle-right-sidebar)] [:td "t r"]]
[:tr [:td (t :help/toggle-settings)] [:td "t s"]]
[:tr [:td (t :help/toggle-insert-new-block)] [:td "t e"]]
[:tr [:td (t :help/jump-to-journals)] [:td (if util/mac? "Cmd-j" "Alt-j")]]]]
[:tr [:td (t :shortcut.ui/toggle-contents)] [:td "t c"]]
[:tr [:td (t :shortcut.ui/toggle-document-mode)] [:td "t d"]]
[:tr [:td (t :shortcut.ui/toggle-theme)] [:td "t t"]]
[:tr [:td (t :shortcut.ui/toggle-right-sidebar)] [:td "t r"]]
[:tr [:td (t :shortcut.ui/toggle-settings)] [:td "t s"]]
[:tr [:td (t :shortcut.ui/toggle-new-block)] [:td "t e"]]
[:tr [:td (t :shortcut.go/journals)] [:td (if util/mac? "Cmd-j" "Alt-j")]]]]
(shortcut-table :shortcut.category/formatting)
(shortcut-table :shortcut.category/toggle)
(shortcut-table :shortcut.category/others)
]
)
)
;; TODO
;; [:tr [:td (t :shortcut.editor/open-link-in-sidebar)] [:td "Shift-Click"]]
;; [:tr [:td (t :help/context-menu)] [:td "Right Click"]]