@yagnikpt/tpaper 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +33 -6
- package/dist/index.js +176 -176
- package/dist/parser.worker.js +6 -2
- package/dist/tree-sitter.wasm +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,6 +12,37 @@ Yes its a [heynote](https://github.com/heyman/heynote) rip-off for the terminal
|
|
|
12
12
|
- **Buffer** — a named collection of blocks, stored as a Markdown file on disk. Roughly analogous to a notebook or a tab.
|
|
13
13
|
- **Block** — an individual note within a buffer, written in Markdown and rendered with syntax highlighting in the terminal.
|
|
14
14
|
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
brew install yagnikpt/tap/tpaper
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
bun install -g @yagnikpt/tpaper
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Keybindings & Features
|
|
26
|
+
* `ctrl+h` — opens the keymaps menu
|
|
27
|
+
|
|
28
|
+
### Editing
|
|
29
|
+
* `i` — Edit the block inline using the built-in editor
|
|
30
|
+
* `ctrl+i` — Edit the block using your external system editor (configured via `$EDITOR`, defaults to `nano`)
|
|
31
|
+
* `enter` — Edit block (opens the built-in inline editor by default, or your system editor if configured)
|
|
32
|
+
|
|
33
|
+
## Configuration
|
|
34
|
+
|
|
35
|
+
The configuration file is located at `~/.config/tpaper-cli/config.yaml` (Linux example).
|
|
36
|
+
|
|
37
|
+
You can customize the following settings:
|
|
38
|
+
|
|
39
|
+
```yaml
|
|
40
|
+
# ~/.config/tpaper-cli/config.yaml
|
|
41
|
+
|
|
42
|
+
# If true, pressing enter/return on a block opens it in your external system editor by default.
|
|
43
|
+
systemEditorByDefault: false
|
|
44
|
+
```
|
|
45
|
+
|
|
15
46
|
## Data storage
|
|
16
47
|
|
|
17
48
|
Everything is stored locally. The exact paths depend on your OS.
|
|
@@ -33,14 +64,10 @@ bun dev # run with file watching
|
|
|
33
64
|
## Building
|
|
34
65
|
|
|
35
66
|
```bash
|
|
36
|
-
bun run build
|
|
67
|
+
bun run build
|
|
37
68
|
```
|
|
38
69
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
BUN_TARGET=bun-darwin-arm64 OUTFILE=./dist/tpaper-mac bun run build
|
|
43
|
-
```
|
|
70
|
+
Builds for all supported platforms (linux-x64, darwin-arm64, linux-arm64, windows-x64, darwin-x64).
|
|
44
71
|
|
|
45
72
|
## Stack
|
|
46
73
|
|