Skip to content
This repository was archived by the owner on Dec 16, 2024. It is now read-only.

Commit c88ea6a

Browse files
committed
fix: update template
1 parent 45603bc commit c88ea6a

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

templates/library-complete/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is a JavaScript library project development template with complete infrastructure and developed using TypeScript to help you quickly build a JavaScript utility library that automatically generates documentation.
44

5-
English | [简体中文](./README_zh.md)
5+
English | [简体中文](https://github.com/hacxy/library-complete-template/blob/main/README_zh.md)
66

77
## Features
88

@@ -109,7 +109,7 @@ npm run release
109109

110110
## How to generate documents
111111

112-
When executing `npm run docs:dev`, typedoc will start in watch mode, and generate markdown documents for all exported methods to the `docs/src` directory. At the same time, vitepress development mode will be launched, and you can preview your document content at <http://localhost:5173/>.
112+
When executing `npm run docs:dev`, typedoc will start in watch mode, and generate markdown documents for all exported methods to the `docs/src` directory. At the same time, vitepress development mode will be launched, and you can preview your document.
113113

114114
Additional documentation content can also be supplemented in method comments, but it is important to note that the comment content should be written according to the [typedoc](https://typedoc.org/guides/overview/) specifications. Here is an example:
115115

templates/library-complete/docs/src/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
This is a JavaScript library project development template with complete infrastructure and developed using TypeScript to help you quickly build a JavaScript utility library that automatically generates documentation.
88

9-
English | [简体中文](./README_zh.md)
9+
English | [简体中文](https://github.com/hacxy/library-complete-template/blob/main/README_zh.md)
1010

1111
## Features
1212

@@ -113,7 +113,7 @@ npm run release
113113

114114
## How to generate documents
115115

116-
When executing `npm run docs:dev`, typedoc will start in watch mode, and generate markdown documents for all exported methods to the `docs/src` directory. At the same time, vitepress development mode will be launched, and you can preview your document content at <http://localhost:5173/>.
116+
When executing `npm run docs:dev`, typedoc will start in watch mode, and generate markdown documents for all exported methods to the `docs/src` directory. At the same time, vitepress development mode will be launched, and you can preview your document.
117117

118118
Additional documentation content can also be supplemented in method comments, but it is important to note that the comment content should be written according to the [typedoc](https://typedoc.org/guides/overview/) specifications. Here is an example:
119119

templates/library-complete/docs/src/functions/addition.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@
2121

2222
## 查看源码
2323

24-
[index.ts:31](https://github.com/hacxy/library-complete-template/blob/4da082efa6195633993e0cab7d7cbbf000bed81f/src/index.ts#L31)
24+
[index.ts:31](https://github.com/hacxy/library-complete-template/blob/f09d8d930b62c19f5fc94416bb0cda4560c0bb0f/src/index.ts#L31)

templates/library-complete/docs/src/functions/helloWorld.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,4 @@ console.log(helloWorld()); // Hello, World!
2020

2121
## 查看源码
2222

23-
[index.ts:22](https://github.com/hacxy/library-complete-template/blob/4da082efa6195633993e0cab7d7cbbf000bed81f/src/index.ts#L22)
23+
[index.ts:22](https://github.com/hacxy/library-complete-template/blob/f09d8d930b62c19f5fc94416bb0cda4560c0bb0f/src/index.ts#L22)

templates/library-complete/docs/src/functions/sayHello.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ console.log(sayHello('hacxy')); // Hello, hacxy!
2626

2727
## 查看源码
2828

29-
[index.ts:10](https://github.com/hacxy/library-complete-template/blob/4da082efa6195633993e0cab7d7cbbf000bed81f/src/index.ts#L10)
29+
[index.ts:10](https://github.com/hacxy/library-complete-template/blob/f09d8d930b62c19f5fc94416bb0cda4560c0bb0f/src/index.ts#L10)

0 commit comments

Comments
 (0)