How sxijyoti/whiskey works
Whiskey is a dependency-aware static site generator. Its principal workflow builds a dependency graph, detects changed inputs, selects affected pages, synchronizes remote content into a workspace, and renders site output. The README documents that overall build sequence, but the central build implementation is not present in the supplied tree, so links among those stages cite the README rather than implying unseen calls. Live serving and remote HTML-to-Markdown extraction are also represented where the supplied excerpts show their behavior.
Main entry points: build.go CLI commands · builder.go Dependency graph · markdown.go Markdown parser · changed.go Input fingerprints
Components 23
Build workflow
- Site configuration
internal/config/config.go - Dependency graph
internal/graph/builder.go - Input fingerprints
internal/fingerprint/changed.go - Dirty-page planner
internal/planner/dirty.go
Source synchronization
- Include resolution
internal/dependency/resolve.go - Source providers
internal/source/registry.go - HTTP source fetch
internal/source/http.go - Workspace materializer
internal/source/materialize.go - Persistent workspace
internal/source/workspace.go - Source cache manifest
internal/source/manifest.go - HTML extraction
internal/transform/extract.go
Content rendering
- Markdown parser
internal/parser/markdown.go - Frontmatter metadata
internal/parser/frontmatter.go - Content shortcodes
internal/parser/shortcode.go - Template renderer
internal/template/render.go - Template loading
internal/template/engine.go
CLI and development
- CLI commands
internal/cli/build.go - File watcher
internal/watcher/watcher.go - Live-reload server
internal/devserver/server.go
Other components
- Site author
- Generated site
- Browser
- Remote web
Connections 28
- Site author → CLI commands: runs commands
internal/cli/build.go - CLI commands → Site configuration: loads settings
- CLI commands → Dependency graph: inspects dependencies
- Dependency graph → Markdown parser: parses metadata
internal/graph/builder.go - Dependency graph → Include resolution: resolves includes
internal/graph/builder.go - Dependency graph → Source providers: resolves sources
internal/graph/builder.go - Input fingerprints → Persistent workspace: reads cached inputs
internal/fingerprint/changed.go - Dependency graph → Input fingerprints: tracks build inputs
- Input fingerprints → Dirty-page planner: reports changes
- Dirty-page planner → Dependency graph: finds affected pages
internal/planner/dirty.go - Dirty-page planner → Generated site: selects rebuilds
- Markdown parser → Frontmatter metadata: extracts metadata
- Markdown parser → Content shortcodes: expands shortcodes
- Template renderer → Template loading: loads layouts
- Template renderer → Generated site: renders pages
- Include resolution → Source providers: resolves providers
- Source providers → HTTP source fetch: creates HTTP source
- HTTP source fetch → Remote web: fetches content
internal/source/http.go - HTTP source fetch → HTML extraction: extracts HTML as Markdown
internal/source/http.go - HTML extraction → Markdown parser: parses frontmatter
internal/transform/extract.go - Workspace materializer → Persistent workspace: stores sources
- Workspace materializer → Source cache manifest: tracks cache metadata
- Persistent workspace → Template renderer: supplies render inputs
- CLI commands → File watcher: starts file watching
- CLI commands → Live-reload server: starts live serving
- File watcher → CLI commands: triggers rebuilds
- Live-reload server → Browser: serves site and reloads
- CLI commands → Workspace materializer: synchronizes sources