How rbmirc/essays works
This repository is a bilingual research-essay site built on Quartz, with private-group Hypothesis annotations documented as an optional collaboration feature. The principal workflow is Markdown ingestion, transformation and filtering, followed by static page generation and a reader-facing site with search, navigation, and language-aware presentation. The source index supports the build/parse/plugin and component relationships shown; unsampled Quartz capabilities are represented at subsystem level where their exact implementation paths are available. Hypothesis wiring is documented in the README, not verified in the sampled source.
Main entry points: parse.ts Markdown parsing · build.ts Build orchestration · quartz.config.ts Site configuration · renderPage.tsx Published site
Components 28
Content processing
- Markdown parsing
quartz/processors/parse.ts - Content transformers
quartz/plugins/transformers - Publish filters
quartz/plugins/filters - Processed content
quartz/plugins/vfile.ts
Static generation
- Build orchestration
quartz/build.ts - Page and asset emitters
quartz/plugins/emitters - Site configuration
quartz.config.ts - Page layout
quartz.layout.ts
Reader experience
- Published site
quartz/components/renderPage.tsx - Page components
quartz/components/ArticleTitle.tsx - Search interface
quartz/components/Search.tsx - Search behavior
quartz/components/scripts/search.inline.ts - Tag and folder pages
quartz/components/pages/TagContent.tsx - Locale translations
quartz/i18n/index.ts - Date display
quartz/components/Date.tsx - Essay listings
quartz/components/PageList.tsx
Shared foundations
- Build context
quartz/util/ctx.ts - Slug and link paths
quartz/util/path.ts - Page resources
quartz/util/resources.tsx - HTML to JSX
quartz/util/jsx.tsx - Theme settings
quartz/util/theme.ts - Build logging
quartz/util/log.ts - Build timing
quartz/util/perf.ts - Error tracing
quartz/util/trace.ts
Other components
- Essay author
- Bilingual essays
- Site reader
- Hypothesis service
Connections 30
- Essay author → Bilingual essays: writes essays
README.md - Bilingual essays → Build orchestration: builds from
- Build orchestration → Site configuration: loads config
quartz/build.ts - Build orchestration → Build context: creates context
quartz/build.ts - Build orchestration → Markdown parsing: parses files
quartz/build.ts - Build orchestration → Publish filters: filters content
quartz/build.ts - Build orchestration → Page and asset emitters: emits output
quartz/build.ts - Markdown parsing → Content transformers: applies plugins
quartz/processors/parse.ts - Markdown parsing → Processed content: produces content
quartz/processors/parse.ts - Markdown parsing → Build context: uses context
quartz/processors/parse.ts - Publish filters → Processed content: checks content
- Page and asset emitters → Processed content: emits from content
- Site configuration → Content transformers: configures plugins
quartz.config.ts - Site configuration → Page layout: configures layout
quartz.layout.ts - Page and asset emitters → Page components: renders pages
- Site reader → Published site: reads
README.md - Published site → Search interface: offers search
- Search interface → Search behavior: loads behavior
quartz/components/Search.tsx - Tag and folder pages → Essay listings: renders listings
quartz/components/pages/TagContent.tsx - Tag and folder pages → HTML to JSX: converts content
quartz/components/pages/TagContent.tsx - Essay listings → Date display: displays dates
quartz/components/PageList.tsx - Locale translations → Published site: translates interface
- Published site → Hypothesis service: loads annotations
README.md - Build context → Site configuration: holds configuration
quartz/util/ctx.ts - Build context → Slug and link paths: uses path types
quartz/util/ctx.ts - Page resources → Processed content: types page data
quartz/util/resources.tsx - Theme settings → Site configuration: defines theme
- Markdown parsing → Build timing: measures parsing
quartz/processors/parse.ts - Markdown parsing → Build logging: logs progress
quartz/processors/parse.ts - Markdown parsing → Error tracing: traces failures
quartz/processors/parse.ts