jixdocs

Vue 3 Markdown 文档与组件开发平台

Features

• 🎯 一体化 - 组件开发 + 文档编写 + 预览调试 + 打包发布
• 🧩 可扩展 - 基于 unified 生态的 Markdown 插件系统 + Vite 插件兼容
• 🎨 易定制 - 分层主题系统：预设主题 → 主题配置 → 局部覆盖 → 完全自定义
• ⚡ 高性能 - Vite 驱动，毫秒级 HMR
• 📦 双模式打包 - 同时支持 npm 包发布和 UMD/ESM 独立库打包
• 🌍 国际化 - 多语言站点支持
• 📝 高级 Markdown - 数学公式 (KaTeX)、Mermaid 图表、脚注、任务列表

Quick Start

# 安装
npm install jixdocs

# 初始化项目
npx jixdocs init my-docs
cd my-docs

# 启动开发服务器
npm run dev

# 构建静态站点
npm run build

# 预览构建产物
npm run preview

CLI Commands

| 命令 | 描述 | |------|------| | jixdocs dev | 启动开发服务器 | | jixdocs build | 构建静态站点 | | jixdocs preview | 预览构建产物 | | jixdocs init | 初始化新项目 | | jixdocs lib build | 打包组件库 | | jixdocs new component-lib | 创建组件库项目 | | jixdocs new theme | 创建主题项目 | | jixdocs new plugin | 创建插件项目 |

Configuration

创建 jixdocs.config.ts 或 .jixdocs/config.ts：

import { defineConfig } from 'jixdocs'

export default defineConfig({
  title: 'My Documentation',
  description: 'A Vue 3 documentation site',
  theme: 'default',

  plugins: [],

  markdown: {
    theme: 'github-dark',
    lineNumbers: true
  },

  themeConfig: {
    logo: '/logo.png',
    nav: [
      { text: 'Guide', link: '/guide/' },
      { text: 'API', link: '/api/' }
    ]
  }
})

License

MIT