No description
| .opencode/rules | ||
| .vale/config/vocabularies/vocab | ||
| resources/transcripts | ||
| scripts | ||
| src | ||
| theme | ||
| .env.example | ||
| .gitignore | ||
| .rumdl.toml | ||
| .vale.ini | ||
| AGENTS.md | ||
| book.toml | ||
| cog.toml | ||
| dprint.json | ||
| justfile | ||
| lefthook.yml | ||
| README.md | ||
Developer Wisdom
A commonplace book of software engineering wisdom, built with mdbook.
Dependencies
Install these tools to build and work on this project:
| Tool | Purpose | Install |
|---|---|---|
| mdbook | Build the book | cargo install mdbook |
| dprint | Format markdown | cargo install dprint |
| rumdl | Lint markdown | cargo install rumdl |
| lefthook | Git hooks | brew install lefthook |
| cocogitto | Validate commits | cargo install cocogitto |
| vale | Grammar linting | brew install vale |
| just | Run commands | brew install just or cargo install just |
| rsync | Deploy to server | Built-in on macOS/Linux |
Getting Started
# Install dependencies
cargo install mdbook dprint rumdl cocogitto just
brew install lefthook vale
# Install git hooks
lefthook install
# Build the book
just build
# Serve locally
just serve
# Format markdown
just fmt
# Check formatting (CI)
just fmt-check
# Lint markdown
rumdl check src/
# Lint prose (grammar, style)
vale src/
Project Structure
src/- Markdown source filesbook/- Built output (gitignored)dprint.json- Markdown formatter configlefthook.yml- Git hook config.rumdl.toml- Markdown linter configjustfile- Build and deploy commandsAGENTS.md- Guidelines for AI agents
Deploy
just deploy
Requires server credentials in .env file.