1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
// Package help holds glint's single source of truth for the keybind and command
// reference, shared by the CLI (glint -h) and the in-editor help overlay.
package help
// Text is the full reference printed by `glint -h` and shown in the Ctrl+/
// overlay inside the editor.
const Text = `glint — a modeless terminal markdown editor
USAGE
glint [file] open a file, or the fuzzy picker when no file is given
glint <command>
COMMANDS (each takes a short letter or the full word, one or two dashes:
-n / --n / -new / --new all work)
-n, --new [name] new note in the current directory
combine with -i or -v to target the inbox or vault
-p, --preview [file] open a file straight into the read preview (glow-style)
-e, --export <file> export a file to printable house-style HTML and open it
-R, --copy-rich <file> copy a file to the clipboard as rich text (macOS only)
-t, --today open today's daily note (in the vault)
-d, --daily browse the daily-notes folder
-v, --vault fuzzy picker over your vault, from anywhere
-i, --inbox fuzzy picker over your inbox
-c, --config interactive setup walkthrough (writes the config file)
-h, --help show this help
--version print the version
EDITOR KEYS
Enter (on a list) continue the list marker (numbers increment, checkboxes
reset); Enter on an empty item exits the list
Tab / Shift+Tab indent / outdent the current list item
Alt+x toggle the checkbox on the current line (- [ ] / - [x],
incl. inside > callouts); clicking the box glyph works too
mouse drag select text (press to anchor, drag to extend)
Alt+Up / Alt+Down move the current line up / down (reorder list items;
the cursor follows the line, so repeats walk it)
Ctrl+S save (an unnamed buffer prompts for a name)
Ctrl+E export a printable HTML doc (house style) and open it in
the browser → Print → Save as PDF
Ctrl+P toggle the read preview
Ctrl+R copy the buffer to the clipboard as rich text (macOS
only; pastes formatted into Mail/Word/Docs/Pages)
Ctrl+F fuzzy file picker (prefix the query with / to full-text
search note contents; results open at the matching line)
Ctrl+G find in document (Enter/down next, Shift+Tab/up prev)
Ctrl+L go to line (type a number, Enter to jump)
Home / End line start (first non-blank, then column 0) / line end
Ctrl+Home / Ctrl+End top / bottom of the document (also Ctrl+Up / Ctrl+Down,
which macOS steals for Mission Control)
Ctrl+D today's daily note
Ctrl+N new note in the current directory
Ctrl+B new note in the inbox
Ctrl+T cycle theme (flexoki-light / flexoki-dark / charm)
Alt+; proofing popup on the misspelled word OR grammar span at
the cursor (pick a suggestion 1-9, a add to dictionary,
i ignore, t toggle spellcheck, g toggle grammar); on a
grammar span the numbered rows are Harper's fixes and
i ignores the hint for the session; clicking an
underlined word opens it
Ctrl+C / Ctrl+X / Ctrl+V copy / cut / paste (system clipboard)
Shift+arrows select text (Ctrl+Shift+left/right by word)
Alt+left / Alt+right move by word
Ctrl+U / Ctrl+K delete to start / end of line
Ctrl+W delete the word before the cursor
Ctrl+Z / Ctrl+Y undo / redo
Ctrl+/ toggle this help overlay
Ctrl+Q quit (press twice if there are unsaved changes)
Esc back to the editor
EDITING
( [ and backtick auto-close (no selection): inserts the matching closer
with the cursor between; type the closer to step past
paste a URL on a selection wraps it as a [selection](url) link
SPELLCHECK & GRAMMAR
Misspelled prose gets a red curly underline. Code, inline code, URLs,
wikilinks, link targets, and frontmatter are never flagged; code files are
off entirely. Personal words live in ~/.config/glint/dict.txt (hand-editable).
Config key spellcheck = auto | on | off.
Grammar checking (green curly underline) is optional and powered by Harper:
install harper-ls (brew install harper) and glint uses it automatically. A
word that is both misspelled and in a grammar span keeps its red underline.
Alt+; on a grammar span lists Harper's fixes (apply one to rewrite the text)
and an Ignore that hides the hint for the session. Config key
grammar = auto | on | off (auto = on when harper-ls is present).
TK markers: the journalism "TK" placeholder (to come) — TK, tk, or TKTK as a
whole word — renders as a bold filled badge so unfinished spots pop. Prose
only; whole-word, so catkin/Atkins/outkast are left alone.
CONFIG
~/.config/glint/config.toml (run 'glint -c' to set it up)
`
|