doc-render-sdk 0.0.1 → 0.0.3

package/README.md

@@ -1,6 +1,6 @@
 # 文档渲染SDK
 
-一个专门用于渲染组件文档站点的SDK，从原有的doc目录抽象而来。
+一个专门用于渲染组件文档站点的SDK
 
 ## 特性
 
@@ -18,13 +18,13 @@
 ### 安装
 
 ```bash
-npm install doc-sdk
+npm install doc-render-sdk
 ```
 
 ### 基本使用
 
 ```javascript
-import DocSDK from 'doc-sdk';
+import DocSDK from 'doc-render-sdk';
 
 const docSdk = new DocSDK({
   title: '我的组件库文档',
@@ -52,100 +52,18 @@ const docSdk = new DocSDK({
 docSdk.render('#app');
 ```
 
-## 架构设计
-
-### 核心模块
-
-- **DocRenderer** - 文档渲染器核心
-- **ConfigManager** - 配置管理器
-- **ComponentRegistry** - 组件注册表
-- **ThemeManager** - 主题管理器
-- **PluginManager** - 插件管理器
-- **RouterManager** - 路由管理器
-
-### 组件系统
-
-- **Layout** - 布局组件
-- **Navigation** - 导航组件
-- **Demo** - 演示组件
-- **ApiDoc** - API文档组件
-- **CodeBlock** - 代码块组件
-- **Search** - 搜索组件
-
-## 目录结构
-
-```
-doc-sdk/
-├── src/
-│   ├── core/           # 核心模块
-│   │   ├── DocRenderer.js      # 文档渲染器
-│   │   ├── ConfigManager.js    # 配置管理器
-│   │   ├── ComponentRegistry.js # 组件注册表
-│   │   ├── ThemeManager.js     # 主题管理器
-│   │   ├── PluginManager.js    # 插件管理器
-│   │   └── RouterManager.js    # 路由管理器
-│   ├── components/     # 文档组件
-│   │   ├── Layout.jsx          # 主布局组件
-│   │   ├── Navigation.jsx      # 导航组件
-│   │   ├── Header.jsx          # 头部组件
-│   │   ├── Content.jsx         # 内容组件
-│   │   ├── Demo.jsx            # Demo展示组件
-│   │   ├── ApiDoc.jsx          # API文档组件
-│   │   ├── CodeBlock.jsx       # 代码块组件
-│   │   ├── Search.jsx          # 搜索组件
-│   │   ├── Home.jsx            # 首页组件
-│   │   └── Footer.jsx          # 页脚组件
-│   ├── themes/         # 主题文件
-│   │   └── default.js          # 默认主题
-│   ├── config/         # 配置文件
-│   │   └── default.js          # 默认配置
-│   ├── utils/          # 工具函数
-│   │   └── index.js            # 工具函数集合
-│   └── index.js        # 入口文件
-├── bin/                # CLI工具
-│   └── doc-sdk.js      # 命令行工具
-├── tools/              # 构建工具
-│   └── migrate.js      # 迁移工具
-├── examples/           # 示例项目
-│   ├── index.html      # 示例HTML
-│   └── index.js        # 示例配置
-├── lib/                # CommonJS构建输出
-├── es/                 # ES模块构建输出
-├── docs-new/           # 迁移示例
-└── README.md           # 说明文档
-```
-
-## 🎯 设计理念
-
-### 核心原则
-
-1. **组件化架构** - 高度模块化，每个功能都是独立的组件
-2. **配置驱动** - 通过配置文件控制所有行为，减少硬编码
-3. **主题化设计** - 支持深度定制，满足不同项目需求
-4. **插件扩展** - 提供插件系统，支持功能扩展
-5. **开发友好** - 提供完整的开发工具链和迁移工具
-
-### 技术栈
-
-- **React** - 组件渲染
-- **Webpack** - 模块打包
-- **Babel** - 代码转换
-- **Less/CSS** - 样式处理
-- **Highlight.js** - 代码高亮
-- **Mini-event** - 事件系统
-
 ## 🚀 快速开始
 
 ### 安装
 
 ```bash
-npm install doc-sdk
+npm install doc-render-sdk
 ```
 
 ### 基本使用
 
 ```javascript
-import DocSDK from 'doc-sdk';
+import DocSDK from 'doc-render-sdk';
 
 const docSdk = new DocSDK({
   title: '我的组件库',
@@ -172,20 +90,20 @@ const docSdk = new DocSDK({
 docSdk.render('#app');
 ```
 
-### CLI 工具
+### CLI 工具 （待支持）
 
 ```bash
 # 创建新项目
-npx doc-sdk create my-docs
+npx doc-render-sdk create my-docs
 
 # 启动开发服务器
-npx doc-sdk dev
+npx doc-render-sdk dev
 
 # 构建项目
-npx doc-sdk build
+npx doc-render-sdk build
 
 # 迁移旧项目
-npx doc-sdk migrate --source ./doc --target ./docs-new
+npx doc-render-sdk migrate --source ./doc --target ./docs-new
 ```
 
 ## 📚 详细文档
@@ -225,12 +143,6 @@ const config = {
       apis: [...]
     }
   },
-
-  // 搜索配置
-  search: {
-    enabled: true,
-    placeholder: '搜索...'
-  }
 };
 ```