wiki/files.md

Markdown Site - File Structure

A brief description of each file in the codebase.

Root Files

File	Description
package.json	Dependencies and scripts for the blog
tsconfig.json	TypeScript configuration
vite.config.ts	Vite bundler configuration
index.html	Main HTML entry with SEO meta tags and JSON-LD
netlify.toml	Netlify deployment and Convex HTTP redirects
README.md	Project documentation
AGENTS.md	AI coding agent instructions (agents.md spec)
files.md	This file - codebase structure
changelog.md	Version history and changes
TASK.md	Task tracking and project status
FORK_CONFIG.md	Fork configuration guide (manual + automated options)
fork-config.json.example	Template JSON config for automated fork setup

Source Files (src/)

Entry Points

File	Description
main.tsx	React app entry point with Convex provider
App.tsx	Main app component with routing
vite-env.d.ts	Vite environment type definitions

Config (src/config/)

File	Description
siteConfig.ts	Centralized site configuration (name, logo, blog page, posts display with homepage post limit and read more link, GitHub contributions, nav order, inner page logo settings, hardcoded navigation items for React routes, GitHub repository config for AI service raw URLs, font family configuration, right sidebar configuration)

Pages (src/pages/)

File	Description
Home.tsx	Landing page with featured content and optional post list. Supports configurable post limit (homePostsLimit) and optional "read more" link (homePostsReadMore) via siteConfig.postsDisplay
Blog.tsx	Dedicated blog page with post list or card grid view (configurable via siteConfig.blogPage, supports view toggle). Includes back button in navigation
Post.tsx	Individual blog post or page view with optional left sidebar (TOC) and right sidebar (CopyPageDropdown). Includes back button, tag links, and related posts section in footer for blog posts. Supports 3-column layout at 1135px+ (update SITE_URL/SITE_NAME when forking)
Stats.tsx	Real-time analytics dashboard with visitor stats and GitHub stars
TagPage.tsx	Tag archive page displaying posts filtered by a specific tag. Includes view mode toggle (list/cards) with localStorage persistence
Write.tsx	Three-column markdown writing page with Cursor docs-style UI, frontmatter reference with copy buttons, theme toggle, font switcher (serif/sans/monospace), and localStorage persistence (not linked in nav)

Components (src/components/)

File	Description
Layout.tsx	Page wrapper with logo in header (top-left), search button, theme toggle, mobile menu (left-aligned on mobile), and scroll-to-top. Combines Blog link, hardcoded nav items, and markdown pages for navigation. Logo reads from siteConfig.innerPageLogo
ThemeToggle.tsx	Theme switcher (dark/light/tan/cloud)
PostList.tsx	Year-grouped blog post list or card grid (supports list/cards view modes)
BlogPost.tsx	Markdown renderer with syntax highlighting, collapsible sections (details/summary), and text wrapping for plain text code blocks
CopyPageDropdown.tsx	Share dropdown with Copy page (markdown to clipboard), View as Markdown (opens raw .md file), Download as SKILL.md (Anthropic Agent Skills format), and Open in AI links (ChatGPT, Claude, Perplexity) using GitHub raw URLs with universal prompt
SearchModal.tsx	Full text search modal with keyboard navigation
FeaturedCards.tsx	Card grid for featured posts/pages with excerpts
LogoMarquee.tsx	Scrolling logo gallery with clickable links
MobileMenu.tsx	Slide-out drawer menu for mobile navigation with hamburger button, includes sidebar table of contents when page has sidebar layout
ScrollToTop.tsx	Configurable scroll-to-top button with Phosphor ArrowUp icon
GitHubContributions.tsx	GitHub activity graph with theme-aware colors and year navigation
VisitorMap.tsx	Real-time visitor location map with dotted world display and theme-aware colors
PageSidebar.tsx	Collapsible table of contents sidebar for pages/posts with sidebar layout, extracts headings (H1-H6), active heading highlighting, smooth scroll navigation, localStorage persistence for expanded/collapsed state
RightSidebar.tsx	Right sidebar component that displays CopyPageDropdown on posts/pages at 1135px+ viewport width, controlled by siteConfig.rightSidebar.enabled and frontmatter rightSidebar field

Context (src/context/)

File	Description
ThemeContext.tsx	Theme state management with localStorage persistence
FontContext.tsx	Font family state management (serif/sans/monospace) with localStorage persistence and siteConfig integration
SidebarContext.tsx	Shares sidebar headings and active ID between Post and Layout components for mobile menu integration

Utils (src/utils/)

File	Description
extractHeadings.ts	Parses markdown content to extract headings (H1-H6), generates slugs, filters out headings inside code blocks

Hooks (src/hooks/)

File	Description
usePageTracking.ts	Page view recording and active session heartbeat

Styles (src/styles/)

File	Description
global.css	Global CSS with theme variables, centralized font-size CSS variables for all themes, sidebar styling with alternate background colors, hidden scrollbar, and consistent borders using box-shadow for docs-style layout. Left sidebar (.post-sidebar-wrapper) and right sidebar (.post-sidebar-right) have separate, independent styles

Convex Backend (convex/)

File	Description
schema.ts	Database schema (posts, pages, viewCounts, pageViews, activeSessions) with by_tags index for tag queries
posts.ts	Queries and mutations for blog posts, view counts, getAllTags, getPostsByTag, and getRelatedPosts
pages.ts	Queries and mutations for static pages
search.ts	Full text search queries across posts and pages
stats.ts	Real-time stats with aggregate component for O(log n) counts, page view recording, session heartbeat
crons.ts	Cron job for stale session cleanup
http.ts	HTTP endpoints: sitemap, API (update SITE_URL/SITE_NAME when forking, uses www.markdown.fast)
rss.ts	RSS feed generation (update SITE_URL/SITE_TITLE when forking, uses www.markdown.fast)
convex.config.ts	Convex app configuration with aggregate component registrations (pageViewsByPath, totalPageViews, uniqueVisitors)
tsconfig.json	Convex TypeScript configuration

HTTP Endpoints (defined in http.ts)

Route	Description
/stats	Real-time site analytics page
/rss.xml	RSS feed with descriptions
/rss-full.xml	RSS feed with full content for LLMs
/sitemap.xml	Dynamic XML sitemap for search engines (includes posts, pages, and tag pages)
/api/posts	JSON list of all posts
/api/post	Single post as JSON or markdown
/api/export	Batch export all posts with content
/meta/post	Open Graph HTML for social crawlers
/.well-known/ai-plugin.json	AI plugin manifest
/openapi.yaml	OpenAPI 3.0 specification
/llms.txt	AI agent discovery

Content (content/blog/)

Markdown files with frontmatter for blog posts. Each file becomes a blog post.

Field	Description
title	Post title
description	Short description for SEO
date	Publication date (YYYY-MM-DD)
slug	URL path for the post
published	Whether post is public
tags	Array of topic tags
readTime	Estimated reading time
image	Header/Open Graph image URL (optional)
excerpt	Short excerpt for card view (optional)
featured	Show in featured section (optional)
featuredOrder	Order in featured section (optional)
authorName	Author display name (optional)
authorImage	Round author avatar image URL (optional)

Static Pages (content/pages/)

Markdown files for static pages like About, Projects, Contact, Changelog.

Field	Description
title	Page title
slug	URL path for the page
published	Whether page is public
order	Display order in navigation (lower first)
showInNav	Show in navigation menu (default: true)
excerpt	Short excerpt for card view (optional)
featured	Show in featured section (optional)
featuredOrder	Order in featured section (optional)
authorName	Author display name (optional)
authorImage	Round author avatar image URL (optional)
rightSidebar	Enable right sidebar with CopyPageDropdown (optional)

Scripts (scripts/)

File	Description
sync-posts.ts	Syncs markdown files to Convex at build time
sync-discovery-files.ts	Updates AGENTS.md and llms.txt with current app data
import-url.ts	Imports external URLs as markdown posts (Firecrawl)
configure-fork.ts	Automated fork configuration (reads fork-config.json)

Sync Commands

Development:

• npm run sync - Sync markdown content to development Convex
• npm run sync:discovery - Update discovery files (AGENTS.md, llms.txt) with development data

Production:

• npm run sync:prod - Sync markdown content to production Convex
• npm run sync:discovery:prod - Update discovery files with production data

Sync everything together:

• npm run sync:all - Run both content sync and discovery sync (development)
• npm run sync:all:prod - Run both content sync and discovery sync (production)

Frontmatter Flow

Frontmatter is the YAML metadata at the top of each markdown file. Here is how it flows through the system:

1. Content directories (content/blog/*.md, content/pages/*.md) contain markdown files with YAML frontmatter
2. scripts/sync-posts.ts uses gray-matter to parse frontmatter and validate required fields
3. Convex mutations (api.posts.syncPostsPublic, api.pages.syncPagesPublic) receive parsed data
4. convex/schema.ts defines the database structure for storing frontmatter fields

To add a new frontmatter field, update:

• scripts/sync-posts.ts: Add to PostFrontmatter or PageFrontmatter interface and parsing logic
• convex/schema.ts: Add field to the posts or pages table schema
• convex/posts.ts or convex/pages.ts: Update sync mutation to handle new field

Netlify (netlify/edge-functions/)

File	Description
botMeta.ts	Edge function for social media crawler detection, excludes /raw/* paths and AI crawlers from OG interception
rss.ts	Proxies /rss.xml and /rss-full.xml to Convex HTTP
sitemap.ts	Proxies /sitemap.xml to Convex HTTP
api.ts	Proxies /api/posts, /api/post, /api/export to Convex
geo.ts	Returns user geo location from Netlify's automatic geo headers for visitor map

Public Assets (public/)

File	Description
favicon.svg	Site favicon
_redirects	SPA redirect rules for static files
robots.txt	Crawler rules for search engines and AI bots (update sitemap URL when forking, uses www.markdown.fast)
llms.txt	AI agent discovery file (update site name/URL when forking, uses www.markdown.fast)
openapi.yaml	OpenAPI 3.0 specification (update API title when forking, uses www.markdown.fast)

Raw Markdown Files (public/raw/)

Static markdown files generated during npm run sync or npm run sync:prod. Each published post and page gets a corresponding .md file for direct access by users, search engines, and AI agents.

File Pattern	Description
{slug}.md	Static markdown file for each post/page

Access via /raw/{slug}.md (e.g., /raw/setup-guide.md).

Files include a metadata header with type (post/page), date, reading time, and tags. The CopyPageDropdown includes a "View as Markdown" option that links directly to these files.

AI Plugin (public/.well-known/)

File	Description
ai-plugin.json	AI plugin manifest (update name/description when forking)

Images (public/images/)

File	Description
logo.svg	Site logo displayed on homepage
og-default.svg	Default Open Graph image for social sharing
*.png/jpg/svg	Blog post images (referenced in frontmatter)

Logo Gallery (public/images/logos/)

File	Description
sample-logo-1.svg	Sample logo (replace with your own)
sample-logo-2.svg	Sample logo (replace with your own)
sample-logo-3.svg	Sample logo (replace with your own)
sample-logo-4.svg	Sample logo (replace with your own)
sample-logo-5.svg	Sample logo (replace with your own)

Cursor Rules (.cursor/rules/)

File	Description
convex-write-conflicts.mdc	Write conflict prevention patterns for Convex
convex2.mdc	Convex function syntax and examples
dev2.mdc	Development guidelines and best practices
help.mdc	Core development guidelines
rulesforconvex.mdc	Convex schema and function best practices
sec-check.mdc	Security guidelines and audit checklist
task.mdc	Task list management guidelines
write.mdc	Writing style guide (activate with @write)