E
简单文档
Docs

入门简介

Estel Docs 是一个基于 Nuxt 4、Nuxt Content v3、Nuxt UI 构建的中文文档与博客系统。

Estel Docs

Estel Docs 是一个面向中文内容写作的文档与博客系统。它以 Nuxt 4、Nuxt Content v3 与 Nuxt UI 为基础，保留 Markdown 的轻量写作体验，同时通过 MDC 与 Vue 组件扩展出更丰富的页面表现。

系统当前包含两条内容线：

文档系统

用于项目说明、使用指南、组件文档、技术资料沉淀，支持侧边栏、目录、编辑链接与上一篇/下一篇导航。

博客系统

用于技术分享、AI 记录、生活随笔等文章发布，支持封面图、发布时间、分页列表与分类标签。

已实现能力

内容管理

  • content/docs/ 与 content/blog/ 双集合结构。
  • 使用 .navigation.yml 配置目录分组。
  • 使用 frontmatter 管理标题、描述、日期、封面图、页面链接等信息。
  • 支持中文目录与中文 slug。
  • 支持 /raw/** 原始 Markdown 查看与复制。

Markdown 增强

  • 支持 Nuxt Content MDC 语法。
  • 支持 GitHub Flavored Markdown。
  • 支持 Mermaid 图表。
  • 支持数学公式（MathJax）。
  • 支持多语言代码高亮。
  • 支持自定义内容组件，例如卡片、标签页、文件树、代码树、在线 Playground、阅读更多等。

阅读体验

  • 桌面端侧边栏导航与右侧目录。
  • 移动端抽屉式导航。
  • 全站搜索，覆盖 docs 与 blog。
  • 页面操作：复制链接、查看 Markdown、在 ChatGPT/Claude 中打开、触发微信分享。
  • 浅色、深色、跟随系统模式。
  • 字体、字号、主题色等页面设置。

SEO、分享与 AI 入口

  • 每个页面设置 SEO 标题与描述。
  • 使用 nuxt-og-image 生成 OG 图片。
  • 使用 nuxt-llms 提供 LLM 友好的站点入口。
  • 微信分享通过前端组件和独立 Go 签名服务协作完成。

工程化

  • pnpm 管理依赖。
  • ESLint 与 Nuxt typecheck。
  • Docker 多阶段构建。
  • GitHub Actions 执行 lint、typecheck、Go tests、Docker build。
  • Renovate 自动维护依赖。
  • CSP、HSTS、Referrer-Policy 等安全响应头。

快速预览

pnpm install
pnpm dev
继续阅读 安装指南 了解本地开发流程，或阅读 功能与路线图 查看当前功能边界与后续规划。

当前边界

  • 登录/注册组件已有 UI 雏形，但尚未接入真实认证后端。
  • Sitemap、robots.txt、RSS、PWA、评论、分析、多语言等能力尚未实现。
  • 代码主题与图注格式设置已持久化，实际渲染联动仍可继续完善。
  • 前端测试体系尚未建立，现有自动化测试主要集中在微信签名 Go 服务。

致谢

  • Nuxt：现代 Vue 全栈框架。
  • Nuxt Content：Markdown 内容管理与渲染能力。
  • Nuxt UI：UI 组件与设计系统。
  • Docus / shadcn-docs-nuxt：文档站体验与组件设计灵感。

License

MIT