[GitHub] [apisix] juzhiyuan opened a new issue #5842: docs: fold phrase in Chinese into one line

[GitBox]

juzhiyuan opened a new issue #5842:
URL: https://github.com/apache/apisix/issues/5842


   ### Improved or typo fixed.
   
   Hi,
   
   In our Chinese Documentations, we have `breaking lines` in original 
markdowns, e.g
   
   ```text
   `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](https://user-images.githubusercontent.com/2106987/146484860-9cd67745-f37c-4587-a204-2131a02cef49.png)
   
   **Firfox**
   
![image](https://user-images.githubusercontent.com/2106987/146484869-e1405ef1-c1d1-4f08-8057-145f4f066636.png)
   
   Here has one PR about this: https://github.com/apache/apisix/pull/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] https://github.com/apache/apisix/pull/5823#issuecomment-996346967
   [3] https://github.com/apache/apisix/pull/5823#discussion_r770244886


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@apisix.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org