Merge pull request #58 from jingjingxyk/feature-build-doc

matyhtf · web-flow · commit 9162a67b4d0b · 2025-07-25T18:55:40.000+08:00
增加生成 文档 命令
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,15 @@
+# EditorConfig is awesome: https://EditorConfig.org
+# https://github.com/editorconfig/editorconfig/wiki/Projects-Using-EditorConfig
+
+root = true
+
+[*]
+insert_final_newline = true
+charset = utf-8
+trim_trailing_whitespace = true
+end_of_line = lf
+
+[*.{md,markdown}]
+trim_trailing_whitespace = false
+indent_size = 2
+indent_style = space
diff --git a/README.md b/README.md
@@ -1,13 +1,26 @@
 # swoole docs
 
-## development
+## development  live preview doc
 
 ```shell
 
-npm install 
+# npm install -g pnpm 
+
+pnpm install 
 # with npm china mirror registry
-# npm install --registry=https://registry.npmmirror.com 
+# pnpm install --registry=https://registry.npmmirror.com 
 
 npm run dev 
 
 ```
+
+## generate doc
+
+默认 web 工作目录位于 public
+The default public web directory is public
+
+```shell
+
+npm run build
+
+```
diff --git a/package.json b/package.json
@@ -14,6 +14,7 @@
   },
   "scripts": {
     "dev": "cd public && npx docsify start .",
+    "build": "cd public && { echo 'web working directory: '$(pwd) ; } && { test -f _sidebar.md && rm -f _sidebar.md ; } && npx docsify generate . ",
     "authors": "git log --format=\"%aN <%aE>\" | sort -u"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`},`
`15`	`15`	`"scripts": {`
`16`	`16`	`"dev": "cd public && npx docsify start .",`
	`17`	`+ "build": "cd public && { echo 'web working directory: '$(pwd) ; } && { test -f _sidebar.md && rm -f _sidebar.md ; } && npx docsify generate . ",`
`17`	`18`	`"authors": "git log --format=\"%aN <%aE>\" \| sort -u"`
`18`	`19`	`}`
`19`	`20`	`}`