VitePress Diataxis Template

Build living doc site, with best practices.

The full-fledged tech doc template powered by VitePress & Diátaxis framework.

View Demo

Highlight Features

• ✅ Diátaxis doc framework
• ✅ Giscus comment & feedback
• ✅ Interactive code sandbox
• ✅ Image viewer in-place
• ✅ Video player in-place
• ✅ Mermaid markdown extension
• ✅ Web analysis & session record/reply on PostHog
• ✅ Auto translation workflow based on GPT-translate
• ✅ Out-of-box i18n including i18n search
• ✅ Stoplight Elements API doc generation
• ✅ Deploy to Cloudflare Pages in 3 minutes

Quick Start

Quick Start in 3 minutes

Reference

• https://diataxis.fr/
• https://code2life.top/blog/0078-how-to-write-good-tech-docs
• https://github.com/logicspark/awesome-vitepress-v1