E
简单文档
Docs

入门简介

Estel Docs 是一个基于 Nuxt 4 , Content v3 , Nuxt UI Pro 构建的文档系统。

缘起

使用过市面上的很多文档系统，但是或多或少都有一些自己不满意的功能.
于是自己动手，丰衣足食.
同时在 Markdown 语法的基础上增加了许多魔法(自定义组件),比如:

在 Markdown 中使用::card 标签,即可创建一个卡片,卡片里可以放置任何内容。比如以下内容:
::card
这里是卡片里的内容
::
代码组
这个组件使用 自定义的 Markdown 语法,从 Markdown 中提取代码块,并展示在页面上 (而其自身亦是一个卡片组)
nuxt.config.ts
export default defineNuxtConfig({
  modules: ['@nuxt/ui-pro'],

  future: {
    compatibilityVersion: 4
  },

  css: ['~/assets/main.css']
});

#### 此组件打开一个模态搜索框,进行搜索
  ::::example-fulltext-content-search
  ::::

#### 此组件建立一个mini搜索框,进行搜索
  ::::example-fulltext-mini-search
  ::::
阅读更多关于 自定义组件 的内容.

特性

  • 基于 Nuxt 4 , Content v3 , Nuxt UI Pro 构建的文档系统。
  • 完美支持 Markdown 和 相关扩展。
  • 和 Vue 组件高度集成。
  • 支持搜索,由Content v3 赋能。
  • 支持多主题,使用Nuxt UI Pro。
  • 开源且免费。
  • 支持移动端。

致谢

  • Nuxt Content：为 Vue 开发者简化内容管理。
  • Nuxt UI Pro ：文档系统 UI 组件。
  • Docus：获取灵感及一些文档组件源代码。

License

MIT