From e90a93c303f8f8c0f1cc96f33fceec9bdfdc4f3b Mon Sep 17 00:00:00 2001 From: Dheepak Krishnamurthy Date: Wed, 24 Mar 2021 12:44:37 -0600 Subject: [PATCH] Update documentation --- .github/workflows/docs.yml | 3 ++- KEYBINDINGS.md => docs/keybindings.md | 10 +++++++++- docs/taskwarrior-tui.1.md | 6 ++++++ mkdocs.yml | 1 + src/help.rs | 2 +- 5 files changed, 19 insertions(+), 3 deletions(-) rename KEYBINDINGS.md => docs/keybindings.md (87%) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 40ab92c..53b721d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -23,7 +23,8 @@ jobs: python3 -m pip install mkdocs-material # install material theme python3 -m pip install pygments pymdown-extensions mkdocs-material-extensions termcolor mkdocs-material mkdocs-macros-plugin - name: Copy README - run: cp README.md docs/index.md + run: | + cp README.md docs/index.md - name: Build site run: mkdocs build - name: Github Pages Deploy diff --git a/KEYBINDINGS.md b/docs/keybindings.md similarity index 87% rename from KEYBINDINGS.md rename to docs/keybindings.md index 366a302..9022334 100644 --- a/KEYBINDINGS.md +++ b/docs/keybindings.md @@ -1,3 +1,5 @@ +# Default Keybindings + Keybindings: Esc: - Exit current action @@ -39,7 +41,11 @@ Keybindings for task report: u: task undo - Undo - x: task delete {selected} - Delete + v: {toggle mark on selected} - Toggle mark on selected + + V: {toggle marks on all tasks} - Toggle marks on tasks in current filter report + + x: task {selected} delete - Delete z: toggle task info - Toggle task info view @@ -63,6 +69,8 @@ Keybindings for context switcher: k: {selected-=1} - Move back a context + Enter: task context {selected} - Select highlighted context + Keybindings for calendar: diff --git a/docs/taskwarrior-tui.1.md b/docs/taskwarrior-tui.1.md index 0ffff4a..d25d20f 100644 --- a/docs/taskwarrior-tui.1.md +++ b/docs/taskwarrior-tui.1.md @@ -91,6 +91,12 @@ Keybindings for task report: `u` : task undo - Undo +`v` +: {toggle mark on selected} - Toggle mark on selected + +`V` +: {toggle marks on all tasks} - Toggle marks on tasks in current filter report + `x` : task delete {selected} - Delete diff --git a/mkdocs.yml b/mkdocs.yml index eceeb14..097ecab 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,6 +44,7 @@ nav: - Getting Started: - Installation: installation.md - Quick Start: quick_start.md + - Keybindings: keybindings.md - Configuration: - Key configuration: configuration/keys.md - Color configuration: configuration/colors.md diff --git a/src/help.rs b/src/help.rs index 594dced..41fcb05 100644 --- a/src/help.rs +++ b/src/help.rs @@ -8,7 +8,7 @@ use tui::{ widgets::{Block, BorderType, Borders, Clear, Paragraph, Widget}, }; -const TEXT: &str = include_str!("../KEYBINDINGS.md"); +const TEXT: &str = include_str!("../docs/keybindings.md"); pub struct Help { pub title: String,