docs: update docs

varletjs · Nov 8, 2024 · 3eb1972 · 3eb1972
1 parent 76c609b
commit 3eb1972
Show file tree

Hide file tree

Showing 46 changed files with 60 additions and 44 deletions.
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,5 +1,9 @@
 # Getting Started
 
+## Overview
+
+`Rattail` is a utilities library for front-end developers, `lightweight` and `ts-friendly`.
+
 ### Installation
 
 ::: code-group
@@ -25,3 +29,7 @@ import { isString } from 'rattail'
 
 console.log(isString('rattail'))
 ```
+
+### Why not Lodash?
+
+`Rattail` is not a replacement for [Lodash](https://lodash.com/) nor a functional programming solution. Rattail aims to provide practical tools for more application scenarios.
diff --git a/docs/zh/array/at.md b/docs/zh/array/at.md
@@ -1,6 +1,6 @@
 # at
 
-获取`数组`中指定索引的元素，支持负索引。
+获取 `数组` 中指定索引的元素，支持负索引。
 
 ### 使用
 

diff --git a/docs/zh/array/find.md b/docs/zh/array/find.md
@@ -1,6 +1,6 @@
 # find
 
-在`数组`中查找`第一个`或`最后一个`满足指定条件的元素，返回该元素及其索引。
+在 `数组` 中查找 `第一个` 或 `最后一个` 满足指定条件的元素，返回该元素及其索引。
 
 ### 使用
 

diff --git a/docs/zh/array/normalize-to-array.md b/docs/zh/array/normalize-to-array.md
@@ -1,6 +1,6 @@
 # normalizeToArray
 
-将值转换为`数组`，如果输入已经是数组，则直接返回输入值。
+将值转换为 `数组`，如果输入已经是数组，则直接返回输入值。
 
 ### 使用
 

diff --git a/docs/zh/array/remove-item.md b/docs/zh/array/remove-item.md
@@ -1,6 +1,6 @@
 # removeItem
 
-从`数组`中移除`第一次`出现的指定元素，返回移除的元素。
+从 `数组` 中移除 `第一次` 出现的指定元素，返回移除的元素。
 
 ### 使用
 

diff --git a/docs/zh/array/shuffle.md b/docs/zh/array/shuffle.md
@@ -1,6 +1,6 @@
 # shuffle
 
-随机打乱`数组`中的元素。
+随机打乱 `数组` 中的元素。
 
 ### 使用
 

diff --git a/docs/zh/array/sum-by.md b/docs/zh/array/sum-by.md
@@ -1,6 +1,6 @@
 # sumBy
 
-根据提供的函数计算`数组`中各项值的和。
+根据提供的函数计算 `数组` 中各项值的和。
 
 ### 使用
 

diff --git a/docs/zh/array/sum.md b/docs/zh/array/sum.md
@@ -1,6 +1,6 @@
 # sum
 
-计算数字`数组`中各项值的和。
+计算数字 `数组` 中各项值的和。
 
 ### 使用
 

diff --git a/docs/zh/array/toggle-item.md b/docs/zh/array/toggle-item.md
@@ -1,6 +1,6 @@
 # toggleItem
 
-根据元素是否在`数组`中，将其添加到数组`末尾`或从数组中移除。
+根据元素是否在 `数组` 中，将其添加到数组 `末尾` 或从数组中移除。
 
 ### 使用
 

diff --git a/docs/zh/array/uniq-by.md b/docs/zh/array/uniq-by.md
@@ -1,6 +1,6 @@
 # uniqBy
 
-使用自定义比较函数返回去重后的`数组`。
+使用自定义比较函数返回去重后的 `数组`。
 
 ### 使用
 

diff --git a/docs/zh/array/uniq.md b/docs/zh/array/uniq.md
@@ -1,6 +1,6 @@
 # uniq
 
-返回去重后的`数组`。
+返回去重后的 `数组`。
 
 ### 使用
 

diff --git a/docs/zh/function/debounce.md b/docs/zh/function/debounce.md
@@ -1,6 +1,6 @@
 # debounce
 
-创建一个防抖函数，该函数会从上一次被调用后，延迟`delay`毫秒后调用`fn`方法。
+创建一个防抖函数，该函数会从上一次被调用后，延迟 `delay` 毫秒后调用 `fn` 方法。
 
 ### 使用
 

diff --git a/docs/zh/general/has-own.md b/docs/zh/general/has-own.md
@@ -1,6 +1,6 @@
 # hasOwn
 
-判断对象是否具有某个`自有（非继承）`属性。
+判断对象是否具有某个 `自有（非继承）` 属性。
 
 ### 使用
 

diff --git a/docs/zh/general/in-browser.md b/docs/zh/general/in-browser.md
@@ -1,6 +1,6 @@
 # inBrowser
 
-判断代码是否在`浏览器环境`中运行。
+判断代码是否在 `浏览器环境` 中运行。
 
 ### 使用
 

diff --git a/docs/zh/general/in-mobile.md b/docs/zh/general/in-mobile.md
@@ -1,6 +1,6 @@
 # inMobile
 
-判断代码是否在`移动浏览器环境`中运行。
+判断代码是否在 `移动浏览器环境` 中运行。
 
 ### 使用
 

diff --git a/docs/zh/general/is-array-buffer.md b/docs/zh/general/is-array-buffer.md
@@ -1,6 +1,6 @@
 # isArrayBuffer
 
-判断输入值是否是`ArrayBuffer`。
+判断输入值是否是 `ArrayBuffer`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-boolean.md b/docs/zh/general/is-boolean.md
@@ -1,6 +1,6 @@
 # isBoolean
 
-判断输入值是否是`布尔值`。
+判断输入值是否是 `布尔值`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-data-view.md b/docs/zh/general/is-data-view.md
@@ -1,6 +1,6 @@
 # isDataView
 
-判断输入值是否是`DataView`。
+判断输入值是否是 `DataView`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-function.md b/docs/zh/general/is-function.md
@@ -1,6 +1,6 @@
 # isFunction
 
-判断输入值是否是`函数`。
+判断输入值是否是 `函数`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-non-empty-array.md b/docs/zh/general/is-non-empty-array.md
@@ -1,6 +1,6 @@
 # isNonEmptyArray
 
-判断输入值是否为`非空数组`。
+判断输入值是否为 `非空数组`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-number.md b/docs/zh/general/is-number.md
@@ -1,6 +1,6 @@
 # isNumber
 
-判断输入值是否是`数字`。
+判断输入值是否是 `数字`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-numeric.md b/docs/zh/general/is-numeric.md
@@ -1,6 +1,6 @@
 # isNumeric
 
-判断输入值是否是`数字`或`数字字符串`。
+判断输入值是否是 `数字` 或 `数字字符串`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-object.md b/docs/zh/general/is-object.md
@@ -1,6 +1,6 @@
 # isObject
 
-判断输入值是否是`对象`（不包括 `null`）。
+判断输入值是否是 `对象`（不包括 `null`）。
 
 ### 使用
 

diff --git a/docs/zh/general/is-plain-object.md b/docs/zh/general/is-plain-object.md
@@ -1,6 +1,6 @@
 # isPlainObject
 
-判断输入值是否是`普通对象`。
+判断输入值是否是 `普通对象`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-string.md b/docs/zh/general/is-string.md
@@ -1,6 +1,6 @@
 # isString
 
-判断输入值是否是`字符串`。
+判断输入值是否是 `字符串`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-symbol.md b/docs/zh/general/is-symbol.md
@@ -1,6 +1,6 @@
 # isSymbol
 
-判断输入值是否是`符号`。
+判断输入值是否是 `符号`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-truthy.md b/docs/zh/general/is-truthy.md
@@ -1,6 +1,6 @@
 # isTruthy
 
-判断输入值是否为`真值`。
+判断输入值是否为 `真值`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-typed-array.md b/docs/zh/general/is-typed-array.md
@@ -1,6 +1,6 @@
 # isTypedArray
 
-判断输入值是否是`TypedArray`。
+判断输入值是否是 `TypedArray`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-weak-map.md b/docs/zh/general/is-weak-map.md
@@ -1,6 +1,6 @@
 # isWeakMap
 
-判断输入值是否是`WeakMap`。
+判断输入值是否是 `WeakMap`。
 
 ### 使用
 

diff --git a/docs/zh/general/is-weak-set.md b/docs/zh/general/is-weak-set.md
@@ -1,6 +1,6 @@
 # isWeakSet
 
-判断输入值是否是`WeakSet`。
+判断输入值是否是 `WeakSet`。
 
 ### 使用
 

diff --git a/docs/zh/general/support-touch.md b/docs/zh/general/support-touch.md
@@ -1,6 +1,6 @@
 # supportTouch
 
-判断当前环境是否支持`触摸事件`。
+判断当前环境是否支持 `触摸事件`。
 
 ### 使用
 

diff --git a/docs/zh/general/to-raw-type.md b/docs/zh/general/to-raw-type.md
@@ -1,6 +1,6 @@
 # toRawType
 
-返回输入值的`原始类型`。
+返回输入值的 `原始类型`。
 
 ### 使用
 

diff --git a/docs/zh/general/to-type-string.md b/docs/zh/general/to-type-string.md
@@ -1,6 +1,6 @@
 # toTypeString
 
-返回输入值的`类型字符串`。
+返回输入值的 `类型字符串`。
 
 ### 使用
 

diff --git a/docs/zh/getting-started.md b/docs/zh/getting-started.md
@@ -1,5 +1,9 @@
 # 快速开始
 
+## 总览
+
+`Rattail` 是一个面向前端开发人员的实用工具库，轻量级且 `ts` 友好
+
 ### 安装
 
 ::: code-group
@@ -25,3 +29,7 @@ import { isString } from 'rattail'
 
 console.log(isString('rattail'))
 ```
+
+### 为什么不是 Lodash？
+
+`Rattail` 不是 [Lodash](https://lodash.com/) 的替代品，也不是函数式编程解决方案。`Rattail` 旨在为更多应用场景提供更加实用的工具。
diff --git a/docs/zh/math/max-by.md b/docs/zh/math/max-by.md
@@ -1,6 +1,6 @@
 # maxBy
 
-在`数组`中查找通过函数应用到每个元素后的`最大值`。如果数组为空，则返回 `undefined`。
+在 `数组` 中查找通过函数应用到每个元素后的 `最大值`。如果数组为空，则返回 `undefined`。
 
 ### 使用
 

diff --git a/docs/zh/math/mean-by.md b/docs/zh/math/mean-by.md
@@ -1,6 +1,6 @@
 # meanBy
 
-通过对`数组`的每个元素应用一个函数以得出数值，计算数组的平均值。
+通过对 `数组` 的每个元素应用一个函数以得出数值，计算数组的平均值。
 
 ### 使用
 

diff --git a/docs/zh/math/min-by.md b/docs/zh/math/min-by.md
@@ -1,6 +1,6 @@
 # minBy
 
-在`数组`中查找通过函数应用到每个元素后的`最小值`。如果数组为空，则返回 `undefined`。
+在 `数组` 中查找通过函数应用到每个元素后的 `最小值`。如果数组为空，则返回 `undefined`。
 
 ### 使用
 

diff --git a/docs/zh/math/sample.md b/docs/zh/math/sample.md
@@ -1,6 +1,6 @@
 # sample
 
-从`数组`中返回一个随机元素。如果数组为空，则返回 `undefined`。
+从 `数组` 中返回一个随机元素。如果数组为空，则返回 `undefined`。
 
 ### 使用
 

diff --git a/docs/zh/math/sum-by.md b/docs/zh/math/sum-by.md
@@ -1,6 +1,6 @@
 # sumBy
 
-根据提供的函数计算`数组`中各项值的和。
+根据提供的函数计算 `数组` 中各项值的和。
 
 ### 使用
 

diff --git a/docs/zh/math/sum.md b/docs/zh/math/sum.md
@@ -1,6 +1,6 @@
 # sum
 
-计算数字`数组`中各项值的和。
+计算数字 `数组` 中各项值的和。
 
 ### 使用
 

diff --git a/docs/zh/string/ensure-prefix.md b/docs/zh/string/ensure-prefix.md
@@ -1,6 +1,6 @@
 # ensurePrefix
 
-确保`字符串`存在某个前缀，如果不存在则添加该前缀。
+确保 `字符串` 存在某个前缀，如果不存在则添加该前缀。
 
 ### 使用
 

diff --git a/docs/zh/string/ensure-suffix.md b/docs/zh/string/ensure-suffix.md
@@ -1,6 +1,6 @@
 # ensureSuffix
 
-确保`字符串`存在某个后缀，如果不存在则添加该后缀。
+确保 `字符串` 存在某个后缀，如果不存在则添加该后缀。
 
 ### 使用
 

diff --git a/docs/zh/string/gen-string-key.md b/docs/zh/string/gen-string-key.md
@@ -1,6 +1,6 @@
 # genStringKey
 
-生成一个唯一的`字符串键`，通过递增数字值并将其转换为字符串。
+生成一个唯一的 `字符串键`，通过递增数字值并将其转换为字符串。
 
 ### 使用
 

diff --git a/docs/zh/string/lower-first.md b/docs/zh/string/lower-first.md
@@ -1,6 +1,6 @@
 # lowerFirst
 
-将`字符串`的`首字母`小写，其余部分保持不变。
+将 `字符串` 的 `首字母` 小写，其余部分保持不变。
 
 ### 使用
 

diff --git a/docs/zh/string/upper-first.md b/docs/zh/string/upper-first.md
@@ -1,6 +1,6 @@
 # upperFirst
 
-将`字符串`的`首字母`大写，其余部分保持不变。
+将 `字符串` 的 `首字母` 大写，其余部分保持不变。
 
 ### 使用
 

diff --git a/docs/zh/util/copy-text.md b/docs/zh/util/copy-text.md
@@ -1,6 +1,6 @@
 # copyText
 
-复制文本到剪贴板
+复制文本到剪贴板。
 
 ### 用法