@linyjs/plugin-docs 0.1.1 → 0.1.2

package/README.md

@@ -33,6 +33,22 @@ cat node_modules/@linyjs/plugin-docs/docs/getting-started/quick-start.md
 ls node_modules/@linyjs/plugin-docs/docs/api-reference/
 ```
 
+### 快速创建插件项目
+
+使用 CLI 工具创建新的插件项目:
+
+```bash
+# 创建新的插件项目
+npx @linyjs/cli init my-plugin
+cd my-plugin
+npm install
+
+# 进入开发模式
+npx @linyjs/cli dev
+```
+
+CLI 工具会自动创建完整的项目结构，包含 package.json、TypeScript 配置和示例代码。
+
 ### 生成示例项目
 
 使用 CLI 工具生成示例项目:

package/docs/getting-started/quick-start.md

@@ -24,6 +24,25 @@
 
 ### 步骤 1: 初始化项目
 
+**推荐方式：使用 CLI 工具自动创建项目**
+
+```bash
+# 使用 @linyjs/cli 创建项目目录和基本文件
+npx @linyjs/cli init hello-plugin
+cd hello-plugin
+
+# 安装依赖
+npm install
+```
+
+CLI 工具会自动创建：
+- package.json (已配置依赖和脚本)
+- tsconfig.json (TypeScript 配置)  
+- src/server/index.ts (服务端代码模板)
+- src/client/index.tsx (客户端代码模板)
+
+**传统方式：手动创建项目**
+
 ```bash
 # 创建项目目录
 mkdir hello-plugin && cd hello-plugin
@@ -36,20 +55,24 @@ npm install @linyjs/server-module-interface @linyjs/client-module-interface reac
 npm install -D typescript @types/react
 ```
 
-### 步骤 2: 创建项目结构
+### 步骤 2: 项目结构
+
+使用 CLI 工具创建的项目已经包含了完整的文件结构：
 
 ```
 hello-plugin/
-├── package.json
-├── tsconfig.json
+├── package.json          # 已预配置的依赖和脚本
+├── tsconfig.json         # 已配置 TypeScript 
 └── src/
     ├── server/
-    │   └── index.ts      # 服务端入口
+    │   └── index.ts      # 服务端入口 (已包含示例代码)
     └── client/
-        └── index.tsx     # 客户端入口
+        └── index.tsx     # 客户端入口 (已包含示例代码)
 ```
 
-**创建 tsconfig.json:**
+**注意**：使用 CLI 创建的项目已经包含了预配置的 package.json 和 tsconfig.json，无需手动创建。
+
+如果你使用了传统方式，需要**手动创建 tsconfig.json:**
 
 ```json
 {
@@ -72,7 +95,9 @@ hello-plugin/
 
 ### 步骤 3: 编写服务端代码
 
-创建 `src/server/index.ts`:
+**使用 CLI 创建的项目已经包含了示例代码**，你已经可以开始开发或修改现有代码。
+
+如果你需要自定义或创建新的服务端代码，编辑 `src/server/index.ts`:
 
 ```typescript
 import type { IModule } from '@linyjs/server-module-interface';
@@ -103,7 +128,9 @@ export const helloServerModule: IModule = {
 
 ### 步骤 4: 编写客户端代码
 
-创建 `src/client/index.tsx`:
+**使用 CLI 创建的项目已经包含了示例代码**，你已经可以开始开发或修改现有代码。
+
+如果你需要自定义或创建新的客户端代码，编辑 `src/client/index.tsx`:
 
 ```typescript
 import type { IModule } from '@linyjs/client-module-interface';
@@ -140,9 +167,25 @@ export const helloClientModule: IModule = {
 
 ### 步骤 5: 构建和打包
 
+**推荐方式：使用开发模式 (dev)**
+
+```bash
+# 一键打包、安装到开发环境
+npx @linyjs/cli dev
+```
+
+这会：
+1. 自动编译 TypeScript
+2. 打包为 .mpk 文件
+3. 安装到 SSR 的 extensions 目录
+4. 注册到 packages.json
+5. 准备就绪后重启 SSR 服务器即可测试
+
+**传统方式：手动打包**
+
 ```bash
 # 编译 TypeScript
-npx tsc
+npm run build
 
 # 使用 CLI 打包为 .mpk 文件
 npx @linyjs/cli pack
@@ -152,6 +195,18 @@ npx @linyjs/cli pack
 
 ### 步骤 6: 测试插件
 
+**使用 CLI dev 模式**（已自动完成安装和注册）:
+
+```bash
+# 启动 SSR 服务器
+cd /path/to/linyjs/packages/ssr
+npx tsx src/demo/dev-server-with-pkg.tsx
+```
+
+访问 `http://localhost:3000/hello` 查看你的插件!
+
+**手动部署**:
+
 ```bash
 # 将插件复制到 extensions 目录
 cp hello-plugin.mpk /path/to/linyjs/packages/ssr/extensions/

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@linyjs/plugin-docs",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Plugin development documentation and examples for linyjs framework",
   "keywords": [
     "linyjs",