Add zk-docs mise task for zettelkasten documentation #10

Merged
eblume merged 2 commits from feature/zk-docs-script into main 2026-01-15 11:25:03 -08:00
3 changed files with 18 additions and 6 deletions
Showing only changes of commit 095fc6feab - Show all commits

Update zk-docs to pass args to bat and update documentation

- zk-docs now passes $@ to bat for custom formatting options
- CLAUDE.md: Use zk-docs command instead of direct file reference,
  with --style=header --color=never --decorations=always for plain
  output with filenames
- README.md: Note that zettelkasten is private, add contact email

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Erich Blume 2026-01-15 11:14:26 -08:00

View file

@ -10,13 +10,19 @@ blumeops is Erich Blume's GitOps repository for personal infrastructure manageme
## Documentation
Project documentation lives in the zettelkasten at `~/code/personal/zk`. Start with the project card: [1767747119-YCPO.md](~/code/personal/zk/1767747119-YCPO.md).
Project documentation lives in the zettelkasten at `~/code/personal/zk`. Read all blumeops documentation with:
You are encouraged to explore the zk, follow links, and propose updates to it as the project evolves.
```bash
mise run zk-docs -- --style=header --color=never --decorations=always
```
This displays all cards tagged `blumeops`, with the main project card first and filenames shown for each card.
You are encouraged to explore the zk, follow links, and propose updates to it as the project evolves. **Always keep the zettelkasten documentation up to date with any changes you make.**
## Rules for all sessions
1. Always start by consulting the project card.
1. Always start by reading the zk docs with the command above.
2. Expand and correct the cards of the zettelkasten.
3. Use `Brewfile` and `mise.toml` to install tools.
4. Use `brew services` or Launch Agents to control services on macos hosts.

View file

@ -51,5 +51,10 @@ to learn.
## Documentation
Detailed documentation lives in my zettelkasten:
- [blumeops project card](~/code/personal/zk/1767747119-YCPO.md)
Detailed documentation lives in my personal zettelkasten, which is not included in this repository. You can view the docs with:
```bash
mise run zk-docs
```
The zettelkasten is private at time of writing. If you're interested in the documentation or have questions about this project, please reach out to blume.erich@gmail.com.

View file

@ -10,4 +10,5 @@ MAIN_CARD="$ZK_DIR/1767747119-YCPO.md"
other_cards=$(grep -l '^ - blumeops$' "$ZK_DIR"/*.md 2>/dev/null | grep -v "$(basename "$MAIN_CARD")" | sort)
# Concatenate: main card first, then others
bat --style=full "$MAIN_CARD" $other_cards
# Pass through any args to bat (e.g., --style=header --color=never --decorations=always)
bat "$@" "$MAIN_CARD" $other_cards