Skip to content

Commit 9feceed

Browse files
committed
🛝 feat: update routing with readme
1 parent 620faa6 commit 9feceed

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README-zh.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@
4545

4646
## 项目结构
4747

48-
```
48+
<pre>
4949
├── src
5050
│ ├── controllers/ --- 控制层,负责调用业务层的接口
5151
│ ├── services/ --- 业务层,负责编写具体的业务代码
5252
│ ├── config.ts --- 用于导出一些全局变量
5353
│ ├── main.ts --- 入口文件
54-
│ └── routes.ts --- 用于配置路由元数据
55-
```
54+
│ └── routes.ts --- 用于配置路由元信息 <a href="#路由配置">👉 路由配置</a>
55+
</pre>
5656

5757
## 安装
5858

@@ -130,7 +130,7 @@ curl --location --request POST 'http://localhost:5000/pdf' \
130130

131131
为了使路由元数据更具可读性和透明性,这里采用了配置化的方式
132132

133-
你可以创建一个 `数组`,然后将路由元信息写入该 `数组` 中,并在 `src/routes.ts` 中重用它
133+
你可以创建一个 `数组`,然后将路由元信息写入该 `数组` 中,并在 [src/routes.ts](https://github.com/pdsuwwz/puppeteer-server/blob/main/src/routes.ts) 中重用它
134134

135135
```ts
136136
const routes: Array<RouteConfig> = [

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,14 @@ Please make sure that [Node.js](https://nodejs.org/) (>= 10.18.1) is installed o
4545

4646
## Project structure
4747

48-
```
48+
<pre>
4949
├── src
5050
│ ├── controllers/ --- Server controllers
5151
│ ├── services/ --- Server services
5252
│ ├── config.ts --- About Environments variable
5353
│ ├── main.ts --- Entry file
54-
│ └── routes.ts --- Configs for routing controllers
55-
```
54+
│ └── routes.ts --- Configs for routing controllers <a href="#Routing">👉 Routing</a>
55+
</pre>
5656

5757
## Installation
5858

@@ -130,7 +130,7 @@ See [Merge Test](https://github.com/pdsuwwz/puppeteer-server/blob/main/__test__/
130130

131131
In order to make the routing information more readable and transparent, the form of configuration is adopted here.
132132

133-
You can create an `array` and then write the routing meta information into the `array`, and reuse it in the `src/routes.ts`
133+
You can create an `array` and then write the routing meta information into the `array`, and reuse it in the [src/routes.ts](https://github.com/pdsuwwz/puppeteer-server/blob/main/src/routes.ts)
134134

135135
```ts
136136
const routes: Array<RouteConfig> = [

0 commit comments

Comments
 (0)