Split TUI from default watch mode
This commit is contained in:
27
readme.md
27
readme.md
@@ -54,7 +54,7 @@ cabal install exe:hakysidian
|
||||
|
||||
## Commands
|
||||
|
||||
The CLI mirrors the common Hakyll workflow:
|
||||
The default CLI mirrors the common Hakyll workflow:
|
||||
|
||||
```bash
|
||||
hakysidian build
|
||||
@@ -70,28 +70,41 @@ hakysidian watch --host 127.0.0.1 --port 8000
|
||||
hakysidian watch --no-server
|
||||
```
|
||||
|
||||
The dashboard is now an explicit TUI mode:
|
||||
|
||||
```bash
|
||||
hakysidian -tui
|
||||
hakysidian -tui --host 127.0.0.1 --port 8000
|
||||
hakysidian -tui --no-server
|
||||
```
|
||||
|
||||
What each command does:
|
||||
|
||||
- `build`: incremental site build.
|
||||
- `clean`: removes generated output and cache.
|
||||
- `rebuild`: clears output/cache and builds from scratch.
|
||||
- `watch`: shows an in-place terminal dashboard, watches project inputs, and rebuilds automatically on change.
|
||||
- `watch`: runs Hakyll's normal watch workflow, prints build logs directly to the terminal, and rebuilds automatically on change.
|
||||
- `-tui`: starts the interactive dashboard with explicit controls for watching and cleaning.
|
||||
|
||||
## Watch Mode
|
||||
## Watch And TUI
|
||||
|
||||
`watch` tracks:
|
||||
Both `watch` and `-tui` work against the same project inputs:
|
||||
|
||||
- `notes/**`
|
||||
- `reference.bib`
|
||||
- `math-macros.md`
|
||||
- `images/**`
|
||||
|
||||
The watch UI:
|
||||
Normal `watch` behaves like a standard Hakyll watch command: it stays in the terminal, rebuilds when inputs change, and can start a preview server unless `--no-server` is passed.
|
||||
|
||||
`-tui` uses an alternate-screen dashboard that:
|
||||
|
||||
- uses the terminal’s current size to keep the dashboard within the visible screen,
|
||||
- keeps recent build output in a bounded activity pane,
|
||||
- avoids scrolling raw Hakyll logs through the terminal,
|
||||
- can start a local preview server unless `--no-server` is passed.
|
||||
- can start a local preview server unless `--no-server` is passed,
|
||||
- supports `w` to start watching, `s` to stop watching, `c` to clean, and `q` to quit.
|
||||
|
||||
The TUI requires an interactive terminal.
|
||||
|
||||
## Notes Format
|
||||
|
||||
|
||||
Reference in New Issue
Block a user