docs: refactor official plugins (vuejs#1442)

shigma · ulivz · commit 8f42d19d4390 · 2019-03-17T22:32:36.000+08:00
diff --git a/packages/docs/docs/plugin/official/plugin-clean-urls.md b/packages/docs/docs/plugin/official/plugin-clean-urls.md
@@ -5,7 +5,7 @@ metaTitle: A plugin of automatically generating clean urls | VuePress
 
 # [@vuepress/plugin-clean-urls](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-clean-urls)
 
-> A plugin of automatically generating clean urls
+> A plugin for automatically generating clean urls. <Badge text="1.0.0-alpha.40+"/>
 
 ## Install
 
@@ -22,6 +22,15 @@ module.exports = {
 }
 ```
 
+::: warning
+This plugin will always work on your dev server, but VuePress **does not have the right** to modify server identification. If you want your URLs to follow a certain pattern (e.g. `/routing` instead of `/routing.html` or `routing/`), you should make sure that your server would treat it as an HTML. This means that you may need to configure your server specifically.
+
+References:
+
+- For Netify users: [https://www.netlify.com/docs/redirects/#trailing-slash](https://www.netlify.com/docs/redirects/#trailing-slash).
+- For Surge users: [https://surge.sh/help/using-clean-urls-automatically](https://surge.sh/help/using-clean-urls-automatically).
+:::
+
 ## Options
 
 ### normalSuffix
diff --git a/packages/docs/docs/plugin/official/plugin-container.md b/packages/docs/docs/plugin/official/plugin-container.md
@@ -5,7 +5,7 @@ metaTitle: A plugin for registering markdown containers | VuePress
 
 # [@vuepress/plugin-container](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-container)
 
-> A plugin for registering markdown containers
+> A plugin for registering markdown containers, based on [markdown-it-container](https://github.com/markdown-it/markdown-it-container). <Badge text="1.0.0-alpha.41+"/>
 
 ## Install
 
diff --git a/packages/docs/docs/plugin/official/plugin-nprogress.md b/packages/docs/docs/plugin/official/plugin-nprogress.md
@@ -5,7 +5,7 @@ metaTitle: Nprogress Plugin | VuePress
 
 # [@vuepress/plugin-nprogress](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-nprogress)
 
-> Nprogress plugin
+> A progress bar plugin based on [nprogress](https://github.com/rstacruz/nprogress). <Badge text="1.0.0-alpha.31+"/>
 
 ## Install
 
diff --git a/packages/docs/docs/zh/plugin/official/plugin-clean-urls.md b/packages/docs/docs/zh/plugin/official/plugin-clean-urls.md
@@ -5,7 +5,7 @@ metaTitle: 自动生成简洁链接的插件 | VuePress
 
 # [@vuepress/plugin-clean-urls](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-clean-urls)
 
-> 自动生成简洁链接的插件
+> 用于自动生成简洁链接的插件。<Badge text="1.0.0-alpha.40+"/>
 
 ## 安装
 
@@ -22,6 +22,15 @@ module.exports = {
 }
 ```
 
+::: warning 注意
+这个插件在 dev 服务器上总是生效的，但 VuePress **并没有能力**去修改服务器识别链接的方式。如果你希望你的网站地址符合某种特殊的模式（比如使用 `/routing` 而不是 `/routing.html` 或者 `routing/`），你需要确保你的服务器会将这些地址认为是 HTML。这可能意味着你需要对你的服务器进行特殊的配置。
+
+参考资料：
+
+- Netify 用户: [https://www.netlify.com/docs/redirects/#trailing-slash](https://www.netlify.com/docs/redirects/#trailing-slash).
+- Surge 用户: [https://surge.sh/help/using-clean-urls-automatically](https://surge.sh/help/using-clean-urls-automatically).
+:::
+
 ## 选项
 
 ### normalSuffix
diff --git a/packages/docs/docs/zh/plugin/official/plugin-container.md b/packages/docs/docs/zh/plugin/official/plugin-container.md
@@ -5,7 +5,7 @@ metaTitle: Markdown 容器插件 | VuePress
 
 # [@vuepress/plugin-container](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-container)
 
-> Markdown 容器插件
+> 用于注册 Markdown 容器的插件，基于 [markdown-it-container](https://github.com/markdown-it/markdown-it-container)。<Badge text="1.0.0-alpha.41+"/>
 
 ## 安装
 
diff --git a/packages/docs/docs/zh/plugin/official/plugin-nprogress.md b/packages/docs/docs/zh/plugin/official/plugin-nprogress.md
@@ -5,7 +5,7 @@ metaTitle: Nprogress 插件 | VuePress
 
 # [@vuepress/plugin-nprogress](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/plugin-nprogress)
 
-> Nprogress plugin
+> 一个基于 [nprogress](https://github.com/rstacruz/nprogress) 的进度条插件。<Badge text="1.0.0-alpha.31+"/>
 
 ## 安装
 
