Add zk-docs mise task for zettelkasten documentation #10
4 changed files with 31 additions and 5 deletions
1
Brewfile
1
Brewfile
|
|
@ -1,2 +1,3 @@
|
|||
# CLI tools for blumeops management
|
||||
brew "bat" # Syntax-highlighted file concatenation
|
||||
brew "tea" # Gitea/Forgejo CLI for forge.tail8d86e.ts.net
|
||||
|
|
|
|||
12
CLAUDE.md
12
CLAUDE.md
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
14
mise-tasks/zk-docs
Executable file
14
mise-tasks/zk-docs
Executable file
|
|
@ -0,0 +1,14 @@
|
|||
#!/usr/bin/env bash
|
||||
#MISE description="Concatenate all blumeops zettelkasten cards"
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
ZK_DIR="$HOME/code/personal/zk"
|
||||
MAIN_CARD="$ZK_DIR/1767747119-YCPO.md"
|
||||
|
||||
# Find all files tagged with blumeops (excluding main card)
|
||||
other_cards=$(grep -l '^ - blumeops$' "$ZK_DIR"/*.md 2>/dev/null | grep -v "$(basename "$MAIN_CARD")" | sort)
|
||||
|
||||
# Concatenate: main card first, then others
|
||||
# Pass through any args to bat (e.g., --style=header --color=never --decorations=always)
|
||||
bat "$@" "$MAIN_CARD" $other_cards
|
||||
Loading…
Add table
Add a link
Reference in a new issue