docs: update docs

novlan1 · Dec 14, 2024 · 7fc9472 · 7fc9472
1 parent bf8bbef
commit 7fc9472
Show file tree

Hide file tree

Showing 92 changed files with 319 additions and 187 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@
   style="margin-bottom: 20px;margin-top: 20px;"
 />
 </div>
+<!-- 复制到 docs 时，去掉 ”详细文档“ 那一节 -->
 
 <p align="center">
   <img src="https://img.shields.io/travis/com/novlan1/t-comm">
@@ -19,7 +20,7 @@
 
 ### 介绍
 
-`t-comm` 是一个丰富、易用的工具库。
+`t-comm` 是一个专业、稳定、纯粹的工具库。
 
 ### 如何使用
 

diff --git a/bin/publish.js b/bin/publish.js
@@ -27,7 +27,7 @@ function publishWithBash({
   port,
 }) {
   const publishBash = require('path').resolve(__dirname, './publish.sh');
-  const command = `sh ${publishBash} ${source} ${target} ${name} ${password} ${port}`;
+  const command = `sh ${publishBash} ${source} ${target} ${name} "${password}" ${port}`;
 
   execSync(command, {
     cwd: process.cwd(),

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -11,8 +11,8 @@ const changeLogSidebar = SHOW_CHANGE_LOG ? [
 
 
 module.exports = {
-  title: 't-comm',
-  description: '丰富易用的工具库',
+  title: 'T Comm',
+  description: '专业、稳定、纯粹的工具库',
   base: process.env.PUBLISH_PATH || '/t-comm/',
   head: [
     [
@@ -46,6 +46,10 @@ module.exports = {
         text: 'Press UI',
         link: 'https://novlan1.github.io/press-ui/',
       },
+      {
+        text: 'Plugin Light',
+        link: 'https://novlan1.github.io/plugin-light/',
+      },
     ],
     sidebar: [
       {

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,17 @@
 # 更新日志
 
+### [1.3.126](https://github.com/novlan1/t-comm/compare/v1.3.125...v1.3.126) (2024-12-13)
+
+
+### Tests ✅
+
+* update test cases ([1c4ddf7](https://github.com/novlan1/t-comm/commit/1c4ddf7b7c6f79dbc4c127da1310120c5e4ceae5))
+
+
+### Features 🎉
+
+* **publish-ci:** 支持特殊符号的密码 ([abb0757](https://github.com/novlan1/t-comm/commit/abb07573a3585e88d3be9c83aba55e748f587dc0))
+
 ### [1.3.125](https://github.com/novlan1/t-comm/compare/v1.3.124...v1.3.125) (2024-12-13)
 
 

diff --git a/docs/README.md b/docs/README.md
@@ -1,11 +1,12 @@
 
 <div align="center">
 <img
-  src="https://mike-1255355338.cos.ap-guangzhou.myqcloud.com/article/2023/10/own_mike_5489135b5a3b9258d8.png" 
+  src="https://mike-1255355338.cos.ap-guangzhou.myqcloud.com/press%2Fimg%2Fown_mike_5489135b5a3b9258d8.gif" 
   width="120"
   style="margin-bottom: 20px;margin-top: 20px;"
 />
 </div>
+<!-- 复制到 docs 时，去掉 ”详细文档“ 那一节 -->
 
 <p align="center">
   <img src="https://img.shields.io/travis/com/novlan1/t-comm">
@@ -19,7 +20,7 @@
 
 ### 介绍
 
-`t-comm` 是一个丰富、易用的工具库。
+`t-comm` 是一个专业、稳定、纯粹的工具库。
 
 ### 如何使用
 
@@ -52,4 +53,3 @@ timeStampFormat(stamp, 'yyyy-MM-dd hh:mm:ss');
 // 2020-11-27 08:23:24
 ```
 
-
diff --git a/docs/zh/ast.md b/docs/zh/ast.md
@@ -1,12 +1,11 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import { parseReplaceConfig, replaceDependencies } from 't-comm';
 
 // or
-
 import { parseReplaceConfig, replaceDependencies} from 't-comm/lib/ast/index';
 ```
 

diff --git a/docs/zh/base/function.md b/docs/zh/base/function.md
@@ -1,12 +1,11 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import { parseFunction, cached } from 't-comm';
 
 // or
-
 import { parseFunction, cached} from 't-comm/lib/base/function/index';
 ```
 

diff --git a/docs/zh/base/list.md b/docs/zh/base/list.md
@@ -1,6 +1,6 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import {
@@ -17,7 +17,6 @@ import {
 } from 't-comm';
 
 // or
-
 import {
   flat,
   flatten,

diff --git a/docs/zh/base/number.md b/docs/zh/base/number.md
@@ -1,6 +1,6 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import {
@@ -16,7 +16,6 @@ import {
 } from 't-comm';
 
 // or
-
 import {
   NUMBER_CHI_MAP,
   getUnitPreviousRatio,

diff --git a/docs/zh/base/object.md b/docs/zh/base/object.md
@@ -1,12 +1,11 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import { toHumpObj, extend } from 't-comm';
 
 // or
-
 import { toHumpObj, extend} from 't-comm/lib/base/object/index';
 ```
 

diff --git a/docs/zh/base/regexp.md b/docs/zh/base/regexp.md
@@ -1,12 +1,11 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import { getMatchListFromReg, getPreReleaseTag } from 't-comm';
 
 // or
-
 import { getMatchListFromReg, getPreReleaseTag} from 't-comm/lib/base/regexp/index';
 ```
 

diff --git a/docs/zh/base/string.md b/docs/zh/base/string.md
@@ -1,6 +1,6 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import {
@@ -11,12 +11,12 @@ import {
   capitalize,
   titleize,
   lowerInitial,
+  pascalCase,
   toUnicodeAt,
   toUnicode
 } from 't-comm';
 
 // or
-
 import {
   checkStringLength,
   replaceAllPolyfill,
@@ -25,6 +25,7 @@ import {
   capitalize,
   titleize,
   lowerInitial,
+  pascalCase,
   toUnicodeAt,
   toUnicode
 } from 't-comm/lib/base/string/index';
@@ -71,17 +72,18 @@ replaceAllPolyfill()
 ```
 <a name="camelize"></a>
 
-## `camelize(str)` 
+## `camelize(str, handleSnake)` 
 
 
-**描述**：<p>横线转驼峰命名</p>
+**描述**：<p>横线转驼峰命名，如果第一个字符是字母，则不处理。</p>
 
 **参数**：
 
 
 | 参数名 | 类型 | 描述 |
 | --- | --- | --- |
 | str | <code>string</code> | <p>输入字符串</p> |
+| handleSnake | <code>boolean</code> | <p>是否处理下划线，默认不处理</p> |
 
 **返回**: <code>string</code><br>
 
@@ -198,6 +200,31 @@ lowerInitial('GroupId')
 
 // groupId
 ```
+<a name="pascalCase"></a>
+
+## `pascalCase(str)` 
+
+
+**描述**：<p>用大驼峰，即 PascalCase 格式，来格式化字符串</p>
+
+**参数**：
+
+
+| 参数名 | 描述 |
+| --- | --- |
+| str | <p>字符串</p> |
+
+**返回**: <p>PascalCase 的字符串</p>
+
+**示例**
+
+```ts
+pascalCase('ab-cd')
+// AbCd
+
+pascalCase('ab_cd')
+// AbCd
+```
 <a name="toUnicodeAt"></a>
 
 ## `toUnicodeAt(str, index)` 

diff --git a/docs/zh/bite.md b/docs/zh/bite.md
@@ -1,12 +1,11 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import { formatBite } from 't-comm';
 
 // or
-
 import { formatBite} from 't-comm/lib/bite/index';
 ```
 

diff --git a/docs/zh/build-upload.md b/docs/zh/build-upload.md
@@ -1,12 +1,11 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import { buildAndUpload } from 't-comm';
 
 // or
-
 import { buildAndUpload} from 't-comm/lib/build-upload/index';
 ```
 

diff --git a/docs/zh/bundle-analyze.md b/docs/zh/bundle-analyze.md
@@ -1,12 +1,11 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import { analyzeIndexBundle } from 't-comm';
 
 // or
-
 import { analyzeIndexBundle} from 't-comm/lib/bundle-analyze/index';
 ```
 

diff --git a/docs/zh/canvas.md b/docs/zh/canvas.md
@@ -1,6 +1,6 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import {
@@ -10,7 +10,6 @@ import {
 } from 't-comm';
 
 // or
-
 import {
   addTextForImg,
   mergeMultiCanvasPic,

diff --git a/docs/zh/change-log.md b/docs/zh/change-log.md
@@ -1,12 +1,11 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import { insertDocChangeLog } from 't-comm';
 
 // or
-
 import { insertDocChangeLog} from 't-comm/lib/change-log/index';
 ```
 

diff --git a/docs/zh/city.md b/docs/zh/city.md
@@ -1,6 +1,6 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import {
@@ -13,7 +13,6 @@ import {
 } from 't-comm';
 
 // or
-
 import {
   getAreaDataAll,
   getAreaData,

diff --git a/docs/zh/clipboard.md b/docs/zh/clipboard.md
@@ -1,12 +1,11 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import { clipboardMp, clipboardWeb } from 't-comm';
 
 // or
-
 import { clipboardMp, clipboardWeb} from 't-comm/lib/clipboard/index';
 ```
 

diff --git a/docs/zh/color.md b/docs/zh/color.md
@@ -1,12 +1,11 @@
 [[toc]]
 
-## 引入
+<h2>引入</h2>
 
 ```ts
 import { rgb2hsv, hsv2rgb } from 't-comm';
 
 // or
-
 import { rgb2hsv, hsv2rgb} from 't-comm/lib/color/index';
 ```