Skip to content
DevPaper — SEO-first VitePress for Static Documentation
DevPaper is an optimized VitePress-based documentation platform that generates SEO-friendly static HTML, boosts performance, and provides a type-safe content pipeline so developers can author, validate, and ship high-quality docs or integrate them into other projects.
Key Benefits
- SEO-first static HTML: Semantic, crawlable pages with unique titles, meta descriptions, canonical URLs, Open Graph/Twitter cards, and JSON-LD (Article + Breadcrumb) produced from frontmatter.
- Type-safe content pipeline: Markdown + frontmatter are parsed into typed
DocPageobjects with validation to catch metadata or structure issues at build time. - Performance optimized: Vite-powered dev server, pre-rendered pages, optimized assets, lazy loading, and small core bundles to improve Core Web Vitals.
- Developer-friendly tooling: Centralized helpers, validators, and tests make it easy to follow SEO best practices and keep content correct.
- Docker-ready deployment: A production-ready
Dockerfileis included for containerized builds and deployments.
How It Works
- Author a Markdown file with YAML frontmatter (see
config_review.mdfor required fields). - The Content Loader scans
docs/,services/, and configured directories to build typedDocPageobjects. - The generator computes head tags, Open Graph/Twitter metadata, and JSON-LD schemas to produce
RenderedDocPageobjects. - The static renderer outputs pre-rendered HTML pages with correct
<head>metadata and structured data.
SEO & Content Requirements
- Required frontmatter includes
layout,type,title,description,category,order,author,publishedAt,updatedAt, androbots— seeconfig_review.mdfor validation rules. - Recommended:
image/ogImage,canonical,tags, andlangfor non-default languages.
Developer Workflow
- Local dev:
npm run dev(Vite/VitePress dev server) - Test:
npm test(includes frontmatter and SEO safety checks) - Build:
npm run build(produce static output, ready for Docker) - Deploy: Build the provided Docker image or export static files to any static host.
Where to add pages
- Add documentation in
docs/and service pages inservices/by creating Markdown files with frontmatter. - Top-level landing pages can be added at the repository root or a configured folder; ensure the site config or plugin routes include them.