https://github.com/code2life/vitepress-diataxis-template
https://github.com/code2life/vitepress-diataxis-template
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/code2life/vitepress-diataxis-template
- Owner: Code2Life
- License: mit
- Created: 2024-09-03T15:18:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T09:25:35.000Z (over 1 year ago)
- Last Synced: 2024-10-24T19:12:31.512Z (over 1 year ago)
- Language: TypeScript
- Size: 111 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-CODE
Awesome Lists containing this project
README
# VitePress Diataxis Template
Build living doc site, with best practices.
The full-fledged tech doc template powered by VitePress & Diátaxis framework.
[View Demo](https://docs.code2life.top)
## Highlight Features
- ✅ [Diátaxis](https://diataxis.fr/) doc framework
- ✅ [Giscus](https://giscus.app/) comment & feedback
- ✅ [Interactive code sandbox](https://docs.code2life.top/guide/playground)
- ✅ [Image viewer](https://docs.code2life.top/guide/plugin-examples#image-viewer) in-place
- ✅ [Video player](https://docs.code2life.top/guide/plugin-examples#video-js) in-place
- ✅ [Mermaid](https://mermaid.live/) markdown extension
- ✅ Web analysis & session record/reply on [PostHog](https://posthog.com/)
- ✅ Auto translation workflow based on [GPT-translate](https://github.com/3ru/gpt-translate)
- ✅ Out-of-box i18n including [i18n search](https://github.com/lucaong/minisearch/issues/201)
- ✅ [Stoplight Elements](https://stoplight-site.webflow.io/open-source/elements) API doc generation
- ✅ Deploy to [Cloudflare Pages](https://docs.code2life.top/guide/deployment) in 3 minutes
## Quick Start
[Quick Start in 3 minutes](https://docs.code2life.top/guide/get-started)
## Reference
- https://diataxis.fr/
- https://code2life.top/blog/0078-how-to-write-good-tech-docs
- https://github.com/logicspark/awesome-vitepress-v1