Skip to content

Commit 97acd56

Browse files
committed
doc: add page about qownnotes-tui
Signed-off-by: Patrizio Bekerle <patrizio@bekerle.com>
1 parent d29b46f commit 97acd56

5 files changed

Lines changed: 82 additions & 1 deletion

File tree

src/libraries/qmarkdowntextedit

webpage/src/.vuepress/config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ const gettingStartedNavItems = [
4646
"getting-started/browser-extension",
4747
"getting-started/homepage-suggestion-api",
4848
"getting-started/command-line-snippet-manager",
49+
"getting-started/qownnotes-tui",
4950
"getting-started/web-app",
5051
"getting-started/qownnotesapi",
5152
"getting-started/note-relations",
65.6 KB
Loading

webpage/src/getting-started/concept.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ graph TB
1717
sync("Nextcloud Sync")-->md
1818
qon-comp("Browser extension")-->qon
1919
qc("Command-line snippet manager")-->qon
20+
tui("QOwnNotes TUI")-->md
2021
homepage("Homepage dashboard")-->qon
2122
end
2223
subgraph Your Nextcloud server
@@ -41,6 +42,7 @@ graph TB
4142
click md "/getting-started/concept.html#markdown-note-files" "Markdown, media and attachment files in your note folder"
4243
click qon-comp "/getting-started/concept.html#qownnotes-browser-extension" "QOwnNotes browser extension for managing bookmarks in markdown files and as web clipper"
4344
click qc "/getting-started/concept.html#qownnotes-command-line-snippet-manager" "QOwnNotes command-line snippet manager"
45+
click tui "/getting-started/concept.html#qownnotes-tui" "QOwnNotes TUI, a keyboard-first terminal browser and editor for your Markdown note folders"
4446
click homepage "/getting-started/concept.html#homepage-dashboard" "Homepage dashboard using QOwnNotes bookmark suggestions"
4547
click sync "/getting-started/concept.html#nextcloud-desktop-sync-client" "Nextcloud desktop sync client to sync your notes to your server"
4648
click ncs "/getting-started/concept.html#nextcloud-server" "Nextcloud server to host your notes and other files"
@@ -125,6 +127,17 @@ You can manage your **command snippets** with QOwnNotes and execute them on the
125127
Please visit [QOwnNotes command-line snippet manager](command-line-snippet-manager.md) for more information.
126128
:::
127129

130+
## QOwnNotes TUI
131+
132+
You can **browse and edit your notes in the terminal** with the keyboard-first
133+
[QOwnNotes TUI](https://github.com/qownnotes/qownnotes-tui). It works directly on
134+
your local Markdown note files and **uses the note folders configured in QOwnNotes**,
135+
following its note sorting settings.
136+
137+
::: tip
138+
Please visit [QOwnNotes TUI](qownnotes-tui.md) for more information.
139+
:::
140+
128141
## LanguageTool service
129142

130143
QOwnNotes can use a local or remote [LanguageTool](https://languagetool.org/) server for
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
image: /img/qownnotes-tui.webp
3+
---
4+
5+
# QOwnNotes TUI
6+
7+
[QOwnNotes TUI](https://github.com/qownnotes/qownnotes-tui) is a keyboard-first
8+
**terminal browser and editor** for local, QOwnNotes-compatible Markdown note folders.
9+
It can directly **use the note folders configured in QOwnNotes**, so you can start
10+
working with your existing notes right away.
11+
12+
![QOwnNotes TUI](/img/qownnotes-tui.webp "Browse and edit your notes in the terminal")
13+
14+
- It uses the **note folders configured in QOwnNotes** and follows its note sorting settings
15+
(the QOwnNotes application database is opened read-only)
16+
- Notes can be **created, edited, searched, syntax-highlighted, renamed from their content**,
17+
and **safely deleted** from the terminal
18+
- Changes are **saved automatically** and external-change conflicts are detected
19+
- It supports **configurable themes**, **mouse controls**, **Nix**, and a **Home Manager module**
20+
- Shell completions can be generated for **Bash, Fish, Zsh**, and more
21+
22+
## Installation
23+
24+
Visit the [latest release page](https://github.com/qownnotes/qownnotes-tui/releases/latest)
25+
and download the version you need.
26+
27+
::: tip
28+
If you are using [Nix](https://nixos.org/), you can build and run the application directly:
29+
30+
```bash
31+
nix run github:qownnotes/qownnotes-tui -- --notes-dir ~/Notes
32+
```
33+
34+
The Nix package installs shell completions for Bash, Fish, and Zsh automatically.
35+
:::
36+
37+
## Usage
38+
39+
Open a note folder from the command line:
40+
41+
```bash
42+
qownnotes-tui --notes-dir ~/Notes
43+
```
44+
45+
If no note folder is given, the application reads all configured note folders from
46+
QOwnNotes and initially opens the current folder.
47+
48+
Some of the most important keys:
49+
50+
| Key | Action |
51+
| --------------- | ------------------------------------- |
52+
| `j`, `k` | Move selection or scroll the viewer |
53+
| `h`, `l`, `Tab` | Switch panes |
54+
| `Enter` | Activate a note folder or open a note |
55+
| `n`, `Ctrl-n` | Create a timestamped note |
56+
| `d` | Delete a note after confirmation |
57+
| `e` | Edit the selected note |
58+
| `/` | Search note names and text |
59+
| `Ctrl-s` | Save the note |
60+
| `Esc` | Leave editor or return to note list |
61+
| `?` | Show help |
62+
| `q`, `Ctrl-c` | Quit |
63+
64+
::: tip
65+
For more information, visit the
66+
[QOwnNotes TUI repository on GitHub](https://github.com/qownnotes/qownnotes-tui).
67+
:::

0 commit comments

Comments
 (0)