mirror of
https://github.com/kdheepak/taskwarrior-tui.git
synced 2025-08-25 08:47:18 +02:00
Update documentation
This commit is contained in:
parent
1b6973f05a
commit
e90a93c303
5 changed files with 19 additions and 3 deletions
3
.github/workflows/docs.yml
vendored
3
.github/workflows/docs.yml
vendored
|
@ -23,7 +23,8 @@ jobs:
|
||||||
python3 -m pip install mkdocs-material # install material theme
|
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
|
python3 -m pip install pygments pymdown-extensions mkdocs-material-extensions termcolor mkdocs-material mkdocs-macros-plugin
|
||||||
- name: Copy README
|
- name: Copy README
|
||||||
run: cp README.md docs/index.md
|
run: |
|
||||||
|
cp README.md docs/index.md
|
||||||
- name: Build site
|
- name: Build site
|
||||||
run: mkdocs build
|
run: mkdocs build
|
||||||
- name: Github Pages Deploy
|
- name: Github Pages Deploy
|
||||||
|
|
|
@ -1,3 +1,5 @@
|
||||||
|
# Default Keybindings
|
||||||
|
|
||||||
Keybindings:
|
Keybindings:
|
||||||
|
|
||||||
Esc: - Exit current action
|
Esc: - Exit current action
|
||||||
|
@ -39,7 +41,11 @@ Keybindings for task report:
|
||||||
|
|
||||||
u: task undo - Undo
|
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
|
z: toggle task info - Toggle task info view
|
||||||
|
|
||||||
|
@ -63,6 +69,8 @@ Keybindings for context switcher:
|
||||||
|
|
||||||
k: {selected-=1} - Move back a context
|
k: {selected-=1} - Move back a context
|
||||||
|
|
||||||
|
Enter: task context {selected} - Select highlighted context
|
||||||
|
|
||||||
|
|
||||||
Keybindings for calendar:
|
Keybindings for calendar:
|
||||||
|
|
|
@ -91,6 +91,12 @@ Keybindings for task report:
|
||||||
`u`
|
`u`
|
||||||
: task undo - Undo
|
: 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`
|
`x`
|
||||||
: task delete {selected} - Delete
|
: task delete {selected} - Delete
|
||||||
|
|
||||||
|
|
|
@ -44,6 +44,7 @@ nav:
|
||||||
- Getting Started:
|
- Getting Started:
|
||||||
- Installation: installation.md
|
- Installation: installation.md
|
||||||
- Quick Start: quick_start.md
|
- Quick Start: quick_start.md
|
||||||
|
- Keybindings: keybindings.md
|
||||||
- Configuration:
|
- Configuration:
|
||||||
- Key configuration: configuration/keys.md
|
- Key configuration: configuration/keys.md
|
||||||
- Color configuration: configuration/colors.md
|
- Color configuration: configuration/colors.md
|
||||||
|
|
|
@ -8,7 +8,7 @@ use tui::{
|
||||||
widgets::{Block, BorderType, Borders, Clear, Paragraph, Widget},
|
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 struct Help {
|
||||||
pub title: String,
|
pub title: String,
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue