Skip to content

Commit

Permalink
feat: update document generation and parsing
Browse files Browse the repository at this point in the history
  • Loading branch information
fanyushun committed Aug 8, 2024
1 parent c77c9be commit bdca68b
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 59 deletions.
48 changes: 24 additions & 24 deletions lib/color-conversion/hexAndRgb.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ import { tenToOther, otherToTen } from './../decimal-conversion'
import { leftPadZero } from './../decimal-conversion/utils'

/**
* **[en:hexRrggbbToHexRgb][zh:十六进制色值简写]**
* **[en:hexRrggbbToHexRgb:][zh:十六进制色值简写:]**
*
* <Badge type="tip" text="version: v0.0.6+" />
*
* @group color-conversion
*
* @param value - [en:Enter #rrggbb][zh:输入十六进制色值(带 `#`,例如`#ffffff`)]
* @returns [en:Return #rgb][zh:返回十六进制色值简写(带 `#`,例如`#fff`)]
* @param value - [en:Enter #rrggbb:][zh:输入十六进制色值(带 `#`,例如`#ffffff`):]
* @returns [en:Return #rgb:][zh:返回十六进制色值简写(带 `#`,例如`#fff`):]
*
* @example
* ```ts
Expand Down Expand Up @@ -45,14 +45,14 @@ export function hexRrggbbToHexRgb (color: string): string {
}

/**
* **[en:hexRgbToHexRrggbb][zh:十六进制色值完整写法]**
* **[en:hexRgbToHexRrggbb:][zh:十六进制色值完整写法:]**
*
* <Badge type="tip" text="version: v0.0.6+" />
*
* @group color-conversion
*
* @param value - [en:Enter #rgb][zh:输入十六进制色值(带 `#`,例如`#fff`)]
* @returns [en:Return #rrggbb][zh:返回十六进制色值完整写法(带 `#`,例如`#ffffff`)]
* @param value - [en:Enter #rgb:][zh:输入十六进制色值(带 `#`,例如`#fff`):]
* @returns [en:Return #rrggbb:][zh:返回十六进制色值完整写法(带 `#`,例如`#ffffff`):]
*
* @example
* ```ts
Expand Down Expand Up @@ -81,14 +81,14 @@ export function hexRgbToHexRrggbb (color: string): string {
}

/**
* **[en:hexRgbsToRgbArray][zh:十六进制色值转RGB数组]**
* **[en:hexRgbsToRgbArray:][zh:十六进制色值转RGB数组:]**
*
* <Badge type="tip" text="version: v0.0.6+" />
*
* @group color-conversion
*
* @param value - [en:Enter #rgb / #rrggbb / #rgba / #rrggbbaa][zh:输入 #rgb / #rrggbb / #rgba / #rrggbbaa]
* @returns [en:Return array][zh:返回数组]
* @param value - [en:Enter #rgb / #rrggbb / #rgba / #rrggbbaa:][zh:输入 #rgb / #rrggbb / #rgba / #rrggbbaa:]
* @returns [en:Return array `[r, g, b, a?]`:][zh:返回数组 `[r, g, b, a?]`:]
*
* @example
* ```ts
Expand Down Expand Up @@ -117,14 +117,14 @@ export function hexRgbsToRgbArray (color: string): number[] {
}

/**
* **[en:hexRgbsToRgbObject][zh:十六进制色值转RGB对象]**
* **[en:hexRgbsToRgbObject:][zh:十六进制色值转RGB对象:]**
*
* <Badge type="tip" text="version: v0.0.7+" />
*
* @group color-conversion
*
* @param value - [en:Enter #rgb / #rrggbb / #rgba / #rrggbbaa][zh:输入 #rgb / #rrggbb / #rgba / #rrggbbaa]
* @returns [en:Return object][zh:返回对象]
* @param value - [en:Enter #rgb / #rrggbb / #rgba / #rrggbbaa:][zh:输入 #rgb / #rrggbb / #rgba / #rrggbbaa:]
* @returns [en:Return object `{r, g, b, a?}`:][zh:返回对象 `{r, g, b, a?}`:]
*
* @example
* ```ts
Expand Down Expand Up @@ -165,14 +165,14 @@ export function hexRgbsToRgbObject (color: string): {
}

/**
* **[en:hexRgbsToRgb][zh:十六进制色值转RGB]**
* **[en:hexRgbsToRgb:][zh:十六进制色值转RGB:]**
*
* <Badge type="tip" text="version: v0.0.6+" />
*
* @group color-conversion
*
* @param value - [en:Enter #rgb / #rrggbb][zh:输入 #rgb 或 #rrggbb]
* @returns [en:Return rgb(r, g, b)][zh:返回 rgb(r, g, b)]
* @param value - [en:Enter #rgb / #rrggbb:][zh:输入 #rgb 或 #rrggbb:]
* @returns [en:Return rgb(r, g, b):][zh:返回 rgb(r, g, b):]
*
* @example
* ```ts
Expand All @@ -195,14 +195,14 @@ export function hexRgbsToRgb (color: string): string {
}

/**
* **[en:rgbToRgbArray][zh:RGB转RGB数组]**
* **[en:rgbToRgbArray:][zh:RGB转RGB数组:]**
*
* <Badge type="tip" text="version: v0.0.6+" />
*
* @group color-conversion
*
* @param value - [en:Enter rgb(r, g, b, a?)][zh:输入 rgb(r, g, b, a?)]
* @returns [en:Return array][zh:返回数组]
* @param value - [en:Enter rgb(r, g, b, a?):][zh:输入 rgb(r, g, b, a?):]
* @returns [en:Return array `[r, g, b, a?]`:][zh:返回数组 `[r, g, b, a?]`:]
*
* @example
* ```ts
Expand All @@ -223,14 +223,14 @@ export function rgbToRgbArray (color: string): number[] {
}

/**
* **[en:rgbToRgbObject][zh:RGB转RGB对象]**
* **[en:rgbToRgbObject:][zh:RGB转RGB对象:]**
*
* <Badge type="tip" text="version: v0.0.7+" />
*
* @group color-conversion
*
* @param value - [en:Enter rgb(r, g, b, a?)][zh:输入 rgb(r, g, b, a?)]
* @returns [en:Return object][zh:返回对象]
* @param value - [en:Enter rgb(r, g, b, a?):][zh:输入 rgb(r, g, b, a?):]
* @returns [en:Return object `{r, g, b, a?}`:][zh:返回对象 `{r, g, b, a?}`:]
*
* @example
* ```ts
Expand Down Expand Up @@ -262,14 +262,14 @@ export function rgbToRgbObject (color: string): {
}

/**
* **[en:rgbToHexRgbs][zh:RGB转十六进制色值]**
* **[en:rgbToHexRgbs:][zh:RGB转十六进制色值:]**
*
* <Badge type="tip" text="version: v0.0.6+" />
*
* @group color-conversion
*
* @param value - [en:Enter rgb(r, g, b, a?)][zh:输入 rgb(r, g, b, a?)]
* @returns [en:Return #rgb / #rrggbb / #rgba / #rrggbbaa][zh:返回 #rgb / #rrggbb / #rgba / #rrggbbaa]
* @param value - [en:Enter rgb(r, g, b, a?):][zh:输入 rgb(r, g, b, a?):]
* @returns [en:Return #rgb / #rrggbb / #rgba / #rrggbbaa:][zh:返回 #rgb / #rrggbb / #rgba / #rrggbbaa:]
*
* @example
* ```ts
Expand Down
18 changes: 9 additions & 9 deletions lib/data-structure/arrayAddListNode.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/**
* **[en:ListNode][zh:链表]**
* **[en:ListNode:][zh:链表:]**
*
* <Badge type="tip" text="version: v0.0.4+" />
*
Expand All @@ -13,8 +13,8 @@
*
* @group data-structure
*
* @param value - [en:Enter value][zh:输入值]
* @param next - [en:next ListNode][zh:`next` 属性对应的 `ListNode`]
* @param value - [en:Enter value:][zh:输入值:]
* @param next - [en:next ListNode:][zh:`next` 属性对应的 `ListNode`:]
*
* @example
* ```ts
Expand All @@ -32,14 +32,14 @@ export class ListNode<T>{
}

/**
* **[en:arrayToListNode][zh:数组转链表]**
* **[en:arrayToListNode:][zh:数组转链表:]**
*
* <Badge type="tip" text="version: v0.0.4+" />
*
* @group data-structure
*
* @param arr - [en:Enter array][zh:输入数组]
* @returns [en:Return ListNode or null][zh:返回链表或者 `null`]
* @param arr - [en:Enter array:][zh:输入数组:]
* @returns [en:Return ListNode or null:][zh:返回链表或者 `null`:]
*
* @example
* ```ts
Expand All @@ -62,14 +62,14 @@ export function arrayToListNode<T>(arr: T[]): ListNode<T> | null {
}

/**
* **[en:listNodeToArray][zh:链表转数组]**
* **[en:listNodeToArray:][zh:链表转数组:]**
*
* <Badge type="tip" text="version: v0.0.6+" />
*
* @group data-structure
*
* @param arr - [en:Enter ListNode or null][zh:输入链表或者 `null`]
* @returns [en:Return array][zh:返回数组]
* @param arr - [en:Enter ListNode or null:][zh:输入链表或者 `null`:]
* @returns [en:Return array:][zh:返回数组:]
*
* @example
* ```ts
Expand Down
12 changes: 6 additions & 6 deletions lib/decimal-conversion/binaryAndOctal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@ import { decimalToBinary, binaryToDecimal } from './decimalAndBinary'
import { leftPadZero } from './utils'

/**
* **[en:octalToBinary][zh:八进制转二进制]**
* **[en:octalToBinary:][zh:八进制转二进制:]**
*
* <Badge type="tip" text="version: v0.0.5+" />
*
* > alias:[`eightToTwo`](eightToTwo)
*
* @group decimal-conversion
*
* @param octal - [en:Enter octal string][zh:输入八进制]
* @returns [en:Return binary string][zh:返回二进制]
* @param octal - [en:Enter octal string:][zh:输入八进制:]
* @returns [en:Return binary string:][zh:返回二进制:]
*
* @example
* ```ts
Expand All @@ -30,16 +30,16 @@ export function octalToBinary (octal: string): string {
export const eightToTwo = octalToBinary

/**
* **[en:binaryToOctal][zh:二进制转八进制]**
* **[en:binaryToOctal:][zh:二进制转八进制:]**
*
* <Badge type="tip" text="version: v0.0.5+" />
*
* > alias:[`twoToEight`](twoToEight)
*
* @group decimal-conversion
*
* @param binary - [en:Enter binary string][zh:输入二进制]
* @returns [en:Return octal string][zh:返回八进制]
* @param binary - [en:Enter binary string:][zh:输入二进制:]
* @returns [en:Return octal string:][zh:返回八进制:]
*
* @example
* ```ts
Expand Down
12 changes: 6 additions & 6 deletions lib/decimal-conversion/decimalAndBinary.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
/**
* **[en:decimalToBinary][zh:十进制转二进制]**
* **[en:decimalToBinary:][zh:十进制转二进制:]**
*
* > alias:[`tenToTwo`](tenToTwo)
*
* @group decimal-conversion
*
* @param num - [en:Enter a value of number type][zh:输入十进制数值]
* @returns [en:Return the corresponding binary][zh:返回二进制]
* @param num - [en:Enter a value of number type:][zh:输入十进制数值:]
* @returns [en:Return the corresponding binary:][zh:返回二进制:]
*
* @example
* ```ts
Expand All @@ -25,14 +25,14 @@ export function decimalToBinary (num: number): string {
export const tenToTwo = decimalToBinary

/**
* **[en:binaryToDecimal][zh:二进制转十进制]**
* **[en:binaryToDecimal:][zh:二进制转十进制:]**
*
* > alias:[`twoToTen`](twoToTen)
*
* @group decimal-conversion
*
* @param str - [en:Enter a value of string type][zh:输入二进制字符串]
* @returns [en:Return the corresponding number][zh:输出十进制数值]
* @param str - [en:Enter a value of string type:][zh:输入二进制字符串:]
* @returns [en:Return the corresponding number:][zh:输出十进制数值:]
*
* @example
* ```ts
Expand Down
16 changes: 8 additions & 8 deletions lib/decimal-conversion/decimalAndOtherBase.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import { getMapNumberToString, getMapStringToNumber } from "./utils"

/**
* **[en:decimalToOtherBase][zh:十进制转任意进制]**
* **[en:decimalToOtherBase:][zh:十进制转任意进制:]**
*
* > alias:[`tenToOther`](tenToOther)
*
* @group decimal-conversion
*
* @param num - [en:Enter a value of number type][zh:输入十进制数值]
* @param base - [en:Target base][zh:目标进制]
* @returns [en:Return the corresponding string][zh:返回目标进制字符串]
* @param num - [en:Enter a value of number type:][zh:输入十进制数值:]
* @param base - [en:Target base:][zh:目标进制:]
* @returns [en:Return the corresponding string:][zh:返回目标进制字符串:]
*
* @example
* ```ts
Expand All @@ -32,15 +32,15 @@ export function decimalToOtherBase (num: number, base: number): string {
export const tenToOther = decimalToOtherBase

/**
* **[en:otherBaseToDecimal][zh:任意进制制转十进制]**
* **[en:otherBaseToDecimal:][zh:任意进制制转十进制:]**
*
* > alias:[`otherToTen`](otherToTen)
*
* @group decimal-conversion
*
* @param str - [en:Enter a value of string type][zh:带转换的字符串]
* @param base - [en:Current base][zh:带转换的字符串的进制]
* @returns [en:Return the corresponding number][zh:输出十进制数值]
* @param str - [en:Enter a value of string type:][zh:带转换的字符串:]
* @param base - [en:Current base:][zh:带转换的字符串的进制:]
* @returns [en:Return the corresponding number:][zh:输出十进制数值:]
*
* @example
* ```ts
Expand Down
12 changes: 6 additions & 6 deletions scripts/docsEnToDocsZh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,18 +61,18 @@ async function changeMd (type: string) {
let oldReadContent = readContent
while (readContent.includes('[zh:')) {
let zhStartIndex = readContent.indexOf('[zh:')
let zhEndIndex = readContent.indexOf(']', zhStartIndex + 1)
let zhEndIndex = readContent.indexOf(':]', zhStartIndex + 1)
const zhContent = readContent.slice(zhStartIndex + 4, zhEndIndex)
zhStartIndex = readContent.lastIndexOf('[', zhStartIndex - 1)
const content = readContent.slice(zhStartIndex, zhEndIndex + 1)
zhStartIndex = readContent.lastIndexOf('[en:', zhStartIndex - 1)
const content = readContent.slice(zhStartIndex, zhEndIndex + 2)
readContent = readContent.replace(content, zhContent)
}
while (oldReadContent.includes('[en:')) {
let enStartIndex = oldReadContent.indexOf('[en:')
let enEndIndex = oldReadContent.indexOf(']', enStartIndex + 1)
let enEndIndex = oldReadContent.indexOf(':]', enStartIndex + 1)
const enContent = oldReadContent.slice(enStartIndex + 4, enEndIndex)
enEndIndex = oldReadContent.indexOf(']', enEndIndex + 1)
const content = oldReadContent.slice(enStartIndex, enEndIndex + 1)
enEndIndex = oldReadContent.indexOf(':]', enEndIndex + 2)
const content = oldReadContent.slice(enStartIndex, enEndIndex + 2)
oldReadContent = oldReadContent.replace(content, enContent)
}
const mdName = item.split('.')[0]
Expand Down

0 comments on commit bdca68b

Please # to comment.