Update documentation

This commit is contained in:
Dheepak Krishnamurthy 2021-03-24 12:44:37 -06:00
parent 1b6973f05a
commit e90a93c303
5 changed files with 19 additions and 3 deletions

View file

@ -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

View file

@ -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:

View file

@ -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

View file

@ -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

View file

@ -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,