How zuoqiu-yingyi/siyuan-packages-monorepo works
Main Components Identification
The system should be represented with these key components:
• Workspace Core
• Shared Packages
• Plugins
• Widgets
• Build & Development Tools
┌─────────────────────────────────── Workspace ───────────────────────────────────┐
• ┌─── Shared Packages ────┐ ┌──── Plugins ─────┐ ┌────── Widgets ─────────┐ │
• Components ◄├──┤ - Custom Block │ │ - Metadata Widget │ │
• Arco │ │ - Custom Fonts │ └─────────────────────────┘ │
• SiYuan ◄├──┤ - Inbox │ │
• Jupyter Client │ ┌────── Tools ────────────┐ │
• Types ◄├──┤ - KeePass │ │ │ │
• Electron │ │ - Monaco Editor ◄├──┤ - ESLint Config │ │
• SiYuan │ │ - OpenAPI │ │ - TSConfig │ │
• OpenCC │ │ - Build Scripts │ │
• Utils ◄├──┤ - Template │ └─────────────────────────┘ │
• DOM │ │ - Typewriter │ │
• Electron │ │ - WakaTime │ │
• File System │ │ - Webview │ │
• ┘ └───────────────────┘ │
• ┘
Additional Details
• Package types and their purposes
• Dependency relationships
• Build/development workflow
• Shared resource utilization
Implementation Notes
• Maintain consistent styling and naming
• Version information where relevant
• Document cross-package dependencies
Documentation Integration
• Referenced in the main README
• Included in development documentation
• Updated with major architectural changes
• Used in onboarding materials
• The overall project structure
• How components interact
• Where to find specific functionality
• How to add new features/plugins
• The build and deployment process