Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix some doc styles for files in doc/ #1475

Merged
merged 4 commits into from
Apr 20, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions doc/admin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#
-->

# Table of contents
# Table of Contents

===

Expand Down Expand Up @@ -167,7 +167,7 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
}'
```

[Back to TOC](#table-of-contents)
[Back to TOC](#Table-of-Contents)

## Service

Expand Down Expand Up @@ -245,7 +245,7 @@ Server: APISIX web server

Return response from etcd currently.

[Back to TOC](#table-of-contents)
[Back to TOC](#Table-of-Contents)

## Consumer

Expand Down Expand Up @@ -312,7 +312,7 @@ Date: Thu, 26 Dec 2019 08:17:49 GMT

Return response from etcd currently.

[Back to TOC](#table-of-contents)
[Back to TOC](#Table-of-Contents)

## Upstream

Expand Down Expand Up @@ -392,7 +392,7 @@ Content-Type: text/plain

Return response from etcd currently.

[Back to TOC](#table-of-contents)
[Back to TOC](#Table-of-Contents)

## SSL

Expand Down Expand Up @@ -428,4 +428,4 @@ Config Example:
}
```

[Back to TOC](#table-of-contents)
[Back to TOC](#Table-of-Contents)
4 changes: 2 additions & 2 deletions doc/plugins/limit-count-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ curl -i http://127.0.0.1:9080/index.html

响应头里面包含了 `X-RateLimit-Limit` 和 `X-RateLimit-Remaining`,他们的含义分别是限制的总请求数和剩余还可以发送的请求数:

```console
```
HTTP/1.1 200 OK
Content-Type: text/html
Content-Length: 13175
Expand All @@ -123,7 +123,7 @@ Server: APISIX web server

当你第三次访问的时候,就会收到包含 503 返回码的响应头:

```console
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

console is a valid decorator actually 😂

```
HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: text/html
Content-Length: 194
Expand Down
4 changes: 2 additions & 2 deletions doc/plugins/limit-count.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ curl -i http://127.0.0.1:9080/index.html
The response header contains `X-RateLimit-Limit` and `X-RateLimit-Remaining`,
which mean the total number of requests and the remaining number of requests that can be sent:

```cosole
```
HTTP/1.1 200 OK
Content-Type: text/html
Content-Length: 13175
Expand All @@ -129,7 +129,7 @@ Server: APISIX web server

When you visit for the third time, you will receive a response with the 503 HTTP code:

```console
```
HTTP/1.1 503 Service Temporarily Unavailable
Content-Type: text/html
Content-Length: 194
Expand Down
6 changes: 3 additions & 3 deletions doc/router-radixtree.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,15 @@ Let's take a look at a few examples and have an intuitive understanding.

#### 1. Full match

```uri
```
/blog/foo
```

It will only match `/blog/foo`.

#### 2. Prefix matching

```uri
```
/blog/bar*
```

Expand All @@ -53,7 +53,7 @@ Full match -> Deep prefix matching.

Here are the rules:

```uri
```
/blog/foo/*
/blog/foo/a/*
/blog/foo/c/*
Expand Down
2 changes: 1 addition & 1 deletion doc/stream-proxy-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ APISIX 可以对 TCP/UDP 协议进行代理并实现动态负载均衡。 在 ng

在 `conf/config.yaml` 配置文件设置 `stream_proxy` 选项, 指定一组需要进行动态代理的IP地址。默认情况不开启stream代理。

```config
```yaml
apisix:
stream_proxy: # TCP/UDP proxy
tcp: # TCP proxy address list
Expand Down
2 changes: 1 addition & 1 deletion doc/stream-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ APISIX can dynamic load balancing TCP/UDP proxy. In Nginx world, we call TCP/UDP
Setting the `stream_proxy` option in `conf/config.yaml`, specify a list of addresses that require dynamic proxy.
By default, no any stream proxy is enabled.

```config
```yaml
apisix:
stream_proxy: # TCP/UDP proxy
tcp: # TCP proxy address list
Expand Down