@pisell/docs
v0.0.1
Published
pisell docs
Keywords
Readme
Pisell Design 文档系统
基于 dumi 构建的 Pisell Design 组件库文档系统,提供完整的组件文档、API 参考和使用指南。
功能特性
- 📚 完整的文档 - 涵盖所有组件的使用指南和 API 文档
- 🎨 实时预览 - 组件演示代码可在线编辑和预览
- 📱 响应式 - 支持移动端访问,随时随地查看文档
- 🔍 搜索功能 - 快速搜索组件和 API
- 🌙 主题切换 - 支持明暗主题切换
- 🌐 多语言 - 支持国际化配置
快速开始
安装依赖
# 安装依赖
pnpm install
# 启动开发服务器
pnpm run dev:docs
# 构建文档
pnpm run build:docs访问文档
开发服务器启动后,访问 http://localhost:8000 即可查看文档。
目录结构
application/docs/
├── docs/ # 文档内容
│ ├── guide/ # 指南文档
│ ├── components/ # 组件文档
│ └── api/ # API 文档
├── src/ # 文档组件源码
├── .dumirc.ts # dumi 配置文件
├── package.json # 项目依赖
└── README.md # 说明文档文档编写指南
文档结构
每个文档文件都应该包含以下 frontmatter:
---
nav:
title: 组件
order: 2
group:
title: 通用
order: 1
title: Button 按钮
order: 1
---组件演示
使用代码块来展示组件使用示例:
