How nirmitaggarwal/theboringedit works
The Boring Edit is a static, markdown-authored personal blog. Authors create posts and track definitions; the content compiler turns them into generated content that the browser app presents as searchable articles and numbered reading series. Readers can track local reading progress without an account or server. The README documents build-time math/code rendering and SEO-friendly static output. Paths and links for some documented build-time capabilities are inferred only at the subsystem level because their implementations were not sampled.
Main entry points: posts.ts Content access · App.tsx App router · build-content.ts Content compiler · content.ts Generated content
Components 20
Markdown authoring
- Post files
content/posts - Track files
content/tracks
Content processing
- Content compiler
scripts/build-content.ts - Markdown renderer
scripts/markdown.ts - Generated content
src/generated/content.ts - SEO output
scripts/seo.ts - Search engine
src/lib/search.ts - Content access
src/lib/posts.ts - Static SEO pages
scripts/prerender.tsx
Reader experience
- App router
src/App.tsx - Home page
src/pages/Home.tsx - Blog index
src/pages/Blog.tsx - Article page
src/pages/Post.tsx - Track pages
src/pages/Tracks.tsx - Track detail
src/pages/Track.tsx - Search palette
src/components/Search.tsx
Reader state
- Progress tracking
src/lib/progress.ts - Browser storage
Other components
- Author
- Reader
Connections 26
- Author → Post files: writes markdown
- Author → Track files: defines series
- Post files → Content compiler: compiles posts
- Track files → Content compiler: compiles tracks
- Content compiler → Markdown renderer: renders content
- Content compiler → Generated content: writes data
- Generated content → Content access: loads content
- Content access → Home page: provides posts
- Content access → Blog index: provides posts
- Content access → Article page: provides articles
- Content access → Track pages: provides series
- Content access → Track detail: provides parts
- Reader → App router: navigates site
- App router → Home page: routes to
- App router → Blog index: routes to
- App router → Article page: routes to
- App router → Track pages: routes to
- App router → Track detail: routes to
- Search palette → Search engine: queries
- Search engine → Content access: reads posts
- Reader → Search palette: searches content
- Article page → Progress tracking: tracks reading
- Track detail → Progress tracking: reads completion
- Progress tracking → Browser storage: reads/writes
- Content compiler → SEO output: generates metadata
- Static SEO pages → Generated content: renders routes