# micro-docs

**Repository Path**: jerrycyl/micro-docs

## Basic Information

- **Project Name**: micro-docs
- **Description**: Micro Docs 是一个基于 Vue 3 开发的现代化文档系统，旨在为项目提供清晰、专业的文档展示平台。系统支持 Markdown 文档的渲染，代码语法高亮，以及响应式设计，确保在各种设备上都能良好显示。

功能特性
✅ 支持 Markdown 文档渲染
✅ 代码语法高亮（支持多种编程语言）
✅ 代码块复制功能
✅ 响应式设计，适配移动端
✅ 文档搜索功能
✅ 分类导航
✅ 现代化商业化软件风
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-03-04
- **Last Updated**: 2026-03-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Micro Docs

## 项目介绍
![输入图片说明](image.png)
Micro Docs 是一个基于 Vue 3 开发的现代化文档系统，旨在为项目提供清晰、专业的文档展示平台。系统支持 Markdown 文档的渲染，代码语法高亮，以及响应式设计，确保在各种设备上都能良好显示。

## 功能特性

- ✅ 支持 Markdown 文档渲染
- ✅ 代码语法高亮（支持多种编程语言）
- ✅ 代码块复制功能
- ✅ 响应式设计，适配移动端
- ✅ 文档搜索功能
- ✅ 分类导航
- ✅ 现代化商业化软件风格的代码块样式
- ✅ 平滑的动画效果

## 技术栈

- **前端框架**: Vue 3 + Composition API
- **构建工具**: Vite
- **路由**: Vue Router
- **Markdown 渲染**: Markdown-it
- **代码高亮**: Highlight.js

## 安装和运行

### 环境要求

- Node.js 16+
- npm 7+

### 安装依赖

```bash
npm install
```

### 开发模式运行

```bash
npm run dev
```

### 构建生产版本

```bash
npm run build
```

### 预览生产构建

```bash
npm run preview
```

## 项目结构

```
micro-docs/
├── docs/              # 文档内容目录
│   ├── bear/          # Bear 相关文档
│   ├── dcat/          # DCat 相关文档
│   └── test-code-styles.md  # 代码样式测试文档
├── src/
│   ├── router/        # 路由配置
│   ├── views/         # 视图组件
│   ├── App.vue        # 根组件
│   └── main.js        # 入口文件
├── .gitignore         # Git 忽略文件
├── index.html         # HTML 模板
├── package.json       # 项目配置
├── package-lock.json  # 依赖锁定文件
└── vite.config.js     # Vite 配置
```

## 使用说明

### 添加文档

1. 在 `docs` 目录下创建新的 Markdown 文件
2. 文档将自动被系统识别并添加到导航中
3. 支持多级目录结构，系统会自动处理目录层级

### 文档格式

- 使用标准 Markdown 语法
- 支持代码块，系统会自动添加语法高亮
- 支持内联代码
- 支持标题、列表、链接等 Markdown 元素