@linyjs/plugin-docs

适用于 linyjs v0.x

查看其他版本: v1.x | v2.x

📖 简介

@linyjs/plugin-docs 是 linyjs 框架的官方插件开发文档和示例包,提供:

• ✅ 结构化文档 - 从入门到进阶的完整教程
• ✅ 可运行示例 - 3个完整的插件示例项目
• ✅ API参考 - 详细的接口文档和类型定义
• ✅ 最佳实践 - 行业标准的开发规范

🚀 快速开始

安装

npm install @linyjs/plugin-docs

访问文档

文档位于 node_modules/@linyjs/plugin-docs/docs/ 目录:

# 查看入门教程
cat node_modules/@linyjs/plugin-docs/docs/getting-started/quick-start.md

# 查看API参考
ls node_modules/@linyjs/plugin-docs/docs/api-reference/

快速创建插件项目

使用 CLI 工具创建新的插件项目:

# 创建新的插件项目
npx @linyjs/cli init my-plugin
cd my-plugin
npm install

# 进入开发模式
npx @linyjs/cli dev

CLI 工具会自动创建完整的项目结构，包含 package.json、TypeScript 配置和示例代码。

生成示例项目

使用 CLI 工具生成示例项目:

# 生成 Hello World 示例
npx @linyjs/cli example hello-world

# 生成博客插件示例
npx @linyjs/cli example blog-plugin -o ./my-blog

📚 文档结构

docs/
├── getting-started/          # 入门教程
│   ├── quick-start.md        # 快速开始
│   ├── installation.md       # 安装指南
│   └── first-plugin.md       # 第一个插件
├── guides/                   # 进阶指南
│   ├── server-module.md      # 服务端模块
│   ├── dependency-injection.md # 依赖注入机制
│   ├── shared-module-interface.md # shared-module-interface 类型包
│   ├── client-module.md      # 客户端模块
│   ├── client-routes.md      # 前端页面路由
│   ├── client-hooks.md       # 公共 Hooks 使用
│   ├── state-management.md   # 前端状态管理
│   ├── ui-slots.md           # UI扩展插槽
│   ├── permissions.md        # 权限管理
│   ├── data-persistence.md   # 数据持久化
│   └── authentication.md     # 用户认证
├── api-reference/            # API参考
│   └── index.md              # 接口定义（含依赖注入接口）
├── best-practices/           # 最佳实践
│   ├── naming-conventions.md
│   ├── service-definition.md  # ServiceDef 代码风格规范
│   ├── error-handling.md
│   ├── performance.md
│   └── security.md
└── faq.md                    # 常见问题

💡 示例项目

examples/
├── hello-world/          # 最简示例(一个API + 一个页面)
├── blog-plugin/          # 完整博客插件(CRUD + 权限)
└── analytics-plugin/     # 数据分析插件(定时任务 + 可视化)

每个示例都是完整的、可独立运行的插件项目,包含:

• 完整的 TypeScript 代码
• package.json 和 tsconfig.json 配置
• 详细的 README 说明
• 可直接打包为 .mpk 文件

🔧 核心模块

linyjs 提供了以下核心模块，插件可以通过依赖注入方式调用这些基础服务：

@linyjs/mdb

MongoDB 数据库服务

• 提供数据持久化存储
• 支持 CRUD 操作和复杂查询
• 详情：数据持久化指南

@linyjs/auth

用户认证系统

• 支持用户注册、登录、Token 验证
• 提供 JWT 身份验证
• 详情：认证指南

@linyjs/permission

权限管理系统

• 基于角色的访问控制(RBAC)
• 细粒度的权限定义
• 详情：权限管理指南

📖 核心模块指南

• 📖 依赖注入机制 — linyjs DI 机制完整说明
• 📦 shared-module-interface — 类型定义包使用说明
• 📊 前端状态管理 — Jotai 全局状态管理
• 💾 数据持久化 - 使用 @linyjs/mdb
• 🔐 用户认证 - 使用 @linyjs/auth
• 🛡️ 权限管理 - 使用 @linyjs/permission

📄 许可证

MIT License