179 lines
7.0 KiB
Markdown
179 lines
7.0 KiB
Markdown
# Note2Any 架构文档索引
|
||
|
||
> **架构版本**: v1.4.0 (模块化核心系统)
|
||
> **更新日期**: 2025年10月16日
|
||
|
||
## 📚 文档导航
|
||
|
||
### 🌟 主要架构文档
|
||
|
||
| 文档 | 描述 | 适用版本 | 推荐度 |
|
||
|------|------|----------|--------|
|
||
| [v1.4.0 架构文档](./architecture-v1.4.0.md) | 🆕 最新完整架构设计 | v1.4.0+ | ⭐⭐⭐⭐⭐ |
|
||
| [架构快速参考](./ARCHITECTURE_QUICK_REFERENCE.md) | 🔄 v1.4.0 快速上手指南 | v1.4.0+ | ⭐⭐⭐⭐⭐ |
|
||
| [架构升级对比](./ARCHITECTURE_UPGRADE_COMPARISON.md) | 🆕 v1.3.x → v1.4.0 对比 | 升级参考 | ⭐⭐⭐⭐ |
|
||
| [优化报告](./OPTIMIZATION_REPORT_v1.3.12.md) | 详细优化过程记录 | v1.3.12 | ⭐⭐⭐ |
|
||
|
||
### 📖 历史架构文档
|
||
|
||
| 文档 | 描述 | 适用版本 | 状态 |
|
||
|------|------|----------|------|
|
||
| [架构总览 (旧版)](./architecture.md) | v1.3.x 旧架构文档 | v1.3.x | 🔒 已过时 |
|
||
| [架构对比 (旧版)](./ARCHITECTURE_COMPARISON.md) | v1.3.x 内部对比 | v1.3.x | 🔒 已过时 |
|
||
| [重构完成报告](./ARCHITECTURE_REFACTORING_COMPLETE.md) | v1.3.x 重构记录 | v1.3.x | 🔒 已过时 |
|
||
|
||
## 🎯 按用途查找文档
|
||
|
||
### 🔰 新用户入门
|
||
1. **了解整体架构**: [v1.4.0 架构文档](./architecture-v1.4.0.md)
|
||
2. **快速上手开发**: [架构快速参考](./ARCHITECTURE_QUICK_REFERENCE.md)
|
||
3. **查看升级改进**: [架构升级对比](./ARCHITECTURE_UPGRADE_COMPARISON.md)
|
||
|
||
### 👨💻 开发者指南
|
||
1. **核心模块使用**: [v1.4.0 架构文档 - 核心模块详解](./architecture-v1.4.0.md#2-核心模块详解)
|
||
2. **添加新功能**: [快速参考 - 常见任务示例](./ARCHITECTURE_QUICK_REFERENCE.md#📝-常见任务示例-v140)
|
||
3. **扩展新平台**: [快速参考 - 添加新平台](./ARCHITECTURE_QUICK_REFERENCE.md#2-添加新平台支持)
|
||
|
||
### 🏗️ 架构设计师
|
||
1. **完整设计文档**: [v1.4.0 架构文档](./architecture-v1.4.0.md)
|
||
2. **设计决策对比**: [架构升级对比](./ARCHITECTURE_UPGRADE_COMPARISON.md)
|
||
3. **性能分析**: [优化报告](./OPTIMIZATION_REPORT_v1.3.12.md)
|
||
|
||
### 🔄 版本升级
|
||
1. **升级指南**: [架构升级对比 - 迁移指南](./ARCHITECTURE_UPGRADE_COMPARISON.md#📚-迁移指南)
|
||
2. **新功能说明**: [v1.4.0 架构文档 - 核心特性](./architecture-v1.4.0.md#🎯-升级概览)
|
||
3. **向后兼容性**: [架构升级对比 - 兼容性](./ARCHITECTURE_UPGRADE_COMPARISON.md#📊-性能对比)
|
||
|
||
## 🔍 核心概念速查
|
||
|
||
### v1.4.0 核心模块
|
||
|
||
| 模块 | 文件路径 | 主要职责 | 文档链接 |
|
||
|------|----------|----------|----------|
|
||
| **ErrorHandler** | `src/core/error-handler.ts` | 统一错误处理 | [详细说明](./architecture-v1.4.0.md#21-errorhandler---统一错误处理) |
|
||
| **ProgressIndicator** | `src/core/progress-indicator.ts` | 进度反馈系统 | [详细说明](./architecture-v1.4.0.md#22-progressindicator---进度反馈系统) |
|
||
| **ConfigManager** | `src/core/config-manager.ts` | 配置管理中心 | [详细说明](./architecture-v1.4.0.md#23-configmanager---配置管理中心) |
|
||
| **PublisherManager** | `src/core/publisher-manager.ts` | 发布平台管理 | [详细说明](./architecture-v1.4.0.md#24-publisherinterface--publishermanager---发布平台抽象) |
|
||
| **ContentProcessor** | `src/core/content-processor.ts` | 内容处理流水线 | [详细说明](./architecture-v1.4.0.md#25-contentprocessor---内容处理流水线) |
|
||
| **ImageProcessor** | `src/core/image-processor.ts` | 图像处理引擎 | [详细说明](./architecture-v1.4.0.md#imageprocessor---图像处理引擎) |
|
||
| **GalleryProcessor** | `src/core/gallery-processor.ts` | 图库处理器 | [详细说明](./architecture-v1.4.0.md#galleryprocessor---图库处理器) |
|
||
| **HtmlProcessor** | `src/core/html-processor.ts` | HTML生成器 | [详细说明](./architecture-v1.4.0.md#htmlprocessor---html生成器) |
|
||
|
||
### 快速API参考
|
||
|
||
```typescript
|
||
// 错误处理
|
||
ErrorHandler.handle(error, 'context');
|
||
|
||
// 进度反馈
|
||
const progress = new ProgressIndicator();
|
||
progress.start('操作开始');
|
||
progress.finish('操作完成');
|
||
|
||
// 配置管理
|
||
const config = ConfigManager.getInstance();
|
||
const value = config.get<T>('key');
|
||
|
||
// 内容处理
|
||
const processor = ContentProcessor.getInstance();
|
||
const result = await processor.process(content);
|
||
|
||
// 平台发布
|
||
const publisher = PublisherManager.getInstance();
|
||
await publisher.publishTo('platform-id', content);
|
||
```
|
||
|
||
## 📊 架构演进历史
|
||
|
||
```mermaid
|
||
timeline
|
||
title Note2Any 架构演进
|
||
|
||
v1.0-1.2 : 基础功能
|
||
: 单文件实现
|
||
: 微信公众号支持
|
||
|
||
v1.3.x : 功能扩展
|
||
: 小红书支持
|
||
: 批量发布
|
||
: 代码重构
|
||
|
||
v1.4.0 : 架构升级
|
||
: 模块化核心系统
|
||
: 9个专业模块
|
||
: 统一错误处理
|
||
: 进度反馈系统
|
||
: 1400+行新代码
|
||
|
||
Future : 持续演进
|
||
: 更多平台支持
|
||
: AI集成
|
||
: 云端同步
|
||
```
|
||
|
||
## 🛠️ 开发工具链
|
||
|
||
### 构建系统
|
||
- **开发构建**: `npm run build` - 未混淆版本，便于调试
|
||
- **生产构建**: `npm run build:obf` - 混淆版本
|
||
- **本地同步**: `./build.sh` - 构建并同步到本地Obsidian
|
||
|
||
### 代码质量
|
||
- **TypeScript**: 100% 类型覆盖，零编译错误
|
||
- **ESLint**: 代码规范检查
|
||
- **模块化**: 9个核心模块，职责明确
|
||
- **测试**: 单元测试和集成测试
|
||
|
||
### 调试工具
|
||
```javascript
|
||
// 浏览器控制台调试命令
|
||
console.log('错误统计:', ErrorHandler.getErrorStats());
|
||
console.log('配置状态:', ConfigManager.getInstance().getAll());
|
||
console.log('已注册处理器:', ContentProcessor.getInstance().getProcessors());
|
||
```
|
||
|
||
## 📋 待办事项
|
||
|
||
### v1.4.x 计划
|
||
- [ ] 完成 article-render.ts 重构
|
||
- [ ] 实现更多内容处理器
|
||
- [ ] 优化性能和稳定性
|
||
- [ ] 完善测试覆盖
|
||
|
||
### v1.5.x 计划
|
||
- [ ] 新平台支持 (知乎、CSDN等)
|
||
- [ ] 插件化处理器市场
|
||
- [ ] AI内容优化集成
|
||
- [ ] 批量操作增强
|
||
|
||
## 🤝 贡献指南
|
||
|
||
### 文档贡献
|
||
1. **更新现有文档**: 发现过时信息请提交PR
|
||
2. **添加新文档**: 新功能需要配套文档
|
||
3. **翻译文档**: 欢迎多语言版本
|
||
|
||
### 代码贡献
|
||
1. **遵循架构**: 使用v1.4.0模块化架构
|
||
2. **错误处理**: 使用ErrorHandler统一处理
|
||
3. **进度反馈**: 长时间操作使用ProgressIndicator
|
||
4. **类型安全**: 保持100% TypeScript覆盖
|
||
|
||
## 📞 获取帮助
|
||
|
||
### 技术支持
|
||
- **问题反馈**: [GitHub Issues](https://biboer.cn/gitea/gavin/note2any/issues)
|
||
- **讨论交流**: [GitHub Discussions](https://biboer.cn/gitea/gavin/note2any/discussions)
|
||
- **文档建议**: 通过Issues提交文档改进建议
|
||
|
||
### 快速联系
|
||
- **架构问题**: 查看[v1.4.0架构文档](./architecture-v1.4.0.md)
|
||
- **开发问题**: 查看[快速参考指南](./ARCHITECTURE_QUICK_REFERENCE.md)
|
||
- **升级问题**: 查看[升级对比文档](./ARCHITECTURE_UPGRADE_COMPARISON.md)
|
||
|
||
---
|
||
|
||
**维护说明**: 本索引文档会随着架构演进持续更新，请定期查看获取最新信息。
|
||
|
||
**文档版本**: v1.4.0
|
||
**最后更新**: 2025年10月16日 |