Skip to content

docs: fold phrase in Chinese into one line #5842

@juzhiyuan

Description

@juzhiyuan

Improved or typo fixed.

Hi,

In our Chinese Documentations, we have breaking lines in original markdowns, e.g

`Plugin` 配置可直接绑定在 `Route` 上,也可以被绑定在 `Service` 或 `Consumer`上。而对于同一
个插件的配置,只能有一份是有效的,配置选择优先级总是 `Consumer` > `Route` > `Service`。

在 `conf/config.yaml` 中,可以声明本地 APISIX 节点都支持哪些插件。这是个白名单机制,不在该
白名单的插件配置,都将会被自动忽略。这个特性可用于临时关闭或打开特定插件,应对突发情况非常有效。
如果你想在现有插件的基础上新增插件,注意需要拷贝 `conf/config-default.yaml` 的插件节点内容到 `conf/config.yaml` 的插件节点中。

And it's be rendered differently in different browsers, e.g

Chrome
image

Firfox
image

Here has one PR about this: #5823

Solution

After discussions in PR #5823, @Josh-Cena suggested we could use Prettier[1] to format our Chinese documentations with "proseWrap": "never" enabled, and it will collapse all wrapping line breaks. And also, Zexuan Luo suggested[2] we could add a CI to check this case 🥳

BTW, for the reason why it will have a different rendered effect, please see this comment[3].

[1] https://prettier.io/
[2] #5823 (comment)
[3] #5823 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    docDocumentation thingsgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions