diff --git a/packages/docs/docs/config/README.md b/packages/docs/docs/config/README.md index fb8d6bfab3..0dfe76dc76 100644 --- a/packages/docs/docs/config/README.md +++ b/packages/docs/docs/config/README.md @@ -21,7 +21,7 @@ The `base` is automatically prepended to all the URLs that start with `/` in oth **Also see:** - [Base URL](../guide/assets.md#base-url) -- [Deploy Guide > Github Pages](../guide/deploy.md#github-pages) +- [Deploy Guide > GitHub Pages](../guide/deploy.md#github-pages) ### title @@ -71,7 +71,7 @@ Specify the port to use for the dev server. - Type: `number` - Default: `@vuepress/core/.temp` -Specify the temporary directory for client. +Specify the temporary directory for client. ### dest diff --git a/packages/docs/docs/guide/deploy.md b/packages/docs/docs/guide/deploy.md index 5608e16d0f..0ba55dbbf1 100644 --- a/packages/docs/docs/guide/deploy.md +++ b/packages/docs/docs/guide/deploy.md @@ -56,7 +56,7 @@ cd - You can also run the above script in your CI setup to enable automatic deployment on each push. ::: -### Github Pages and Travis CI +### GitHub Pages and Travis CI 1. Set correct `base` in `docs/.vuepress/config.js`. @@ -66,7 +66,7 @@ You can also run the above script in your CI setup to enable automatic deploymen 2. Create a file named `.travis.yml` in the root of your project. -3. Use Github Pages deploy provider template and follow the [travis documentation](https://docs.travis-ci.com/user/deployment/pages/). +3. Use GitHub Pages deploy provider template and follow the [travis documentation](https://docs.travis-ci.com/user/deployment/pages/). ``` yaml language: node_js @@ -168,7 +168,7 @@ You can also deploy to a [custom domain](http://surge.sh/help/adding-a-custom-do 2. Create a Heroku account [here](https://signup.heroku.com). 3. Run `heroku login` and fill in your Heroku credentials: - + ``` bash heroku login ``` diff --git a/packages/docs/docs/zh/config/README.md b/packages/docs/docs/zh/config/README.md index 816feb3cd4..21956e7ada 100644 --- a/packages/docs/docs/zh/config/README.md +++ b/packages/docs/docs/zh/config/README.md @@ -12,14 +12,14 @@ sidebar: auto - 类型: `string` - 默认值: `/` -部署站点的基础路径,如果你想让你的网站部署到一个子路径下,你将需要设置它。如 Github pages,如果你想将你的网站部署到 `https://foo.github.io/bar/`,那么 `base` 应该被设置成 `"/bar/"`,它的值应当总是以斜杠开始,并以斜杠结束。 +部署站点的基础路径,如果你想让你的网站部署到一个子路径下,你将需要设置它。如 GitHub pages,如果你想将你的网站部署到 `https://foo.github.io/bar/`,那么 `base` 应该被设置成 `"/bar/"`,它的值应当总是以斜杠开始,并以斜杠结束。 `base` 将会自动地作为前缀插入到所有以 `/` 开始的其他选项的链接中,所以你只需要指定一次。 **参考:** - [Base URL](../guide/assets.md#基础路径) -- [部署指南 > Github Pages](../guide/deploy.md#github-pages) +- [部署指南 > GitHub Pages](../guide/deploy.md#github-pages) ### title @@ -131,7 +131,7 @@ $codeBgColor = #282c34 ### index.styl -VuePress 提供了一种添加额外样式的简便方法。你可以创建一个 `.vuepress/styles/index.styl` 文件。这是一个 [Stylus](http://stylus-lang.com/) 文件,但你也可以使用正常的 CSS 语法。 +VuePress 提供了一种添加额外样式的简便方法。你可以创建一个 `.vuepress/styles/index.styl` 文件。这是一个 [Stylus](http://stylus-lang.com/) 文件,但你也可以使用正常的 CSS 语法。 ```stylus .content { diff --git a/packages/docs/docs/zh/guide/deploy.md b/packages/docs/docs/zh/guide/deploy.md index 0d26e0866a..4b2e283a58 100644 --- a/packages/docs/docs/zh/guide/deploy.md +++ b/packages/docs/docs/zh/guide/deploy.md @@ -56,16 +56,16 @@ cd - 你可以在你的持续集成的设置中,设置在每次 push 代码时自动运行上述脚本。 ::: -### Github Pages and Travis CI +### GitHub Pages and Travis CI 1. 在 `docs/.vuepress/config.js` 中设置正确的 `base`。 如果你打算发布到 `https://.github.io/`,则可以省略这一步,因为 `base` 默认即是 `"/"`。 - + 如果你打算发布到 `https://.github.io//`(也就是说你的仓库在 `https://github.com//`),则将 `base` 设置为 `"//"`。 - + 2. 在项目的根目录创建一个名为 `.travis.yml` 的文件; -3. 使用 Github Pages 部署提供程序模板并遵循 [Travis 文档](https://docs.travis-ci.com/user/deployment/pages/)。 +3. 使用 GitHub Pages 部署提供程序模板并遵循 [Travis 文档](https://docs.travis-ci.com/user/deployment/pages/)。 ``` yaml language: node_js @@ -88,9 +88,9 @@ deploy: 1. 在 `docs/.vuepress/config.js` 中设置正确的 `base`。 如果你打算发布到 `https://.gitlab.io/`,则可以省略这一步,因为 `base` 默认即是 `"/"`。 - + 如果你打算发布到 `https://.gitlab.io//`(也就是说你的仓库在 `https://gitlab.com//`),则将 `base` 设置为 `"//"`。 - + 2. 在 `.vuepress/config.js` 中将 `dest` 设置为 `public`。 3. 在你项目的根目录下创建一个名为 `.gitlab-ci.yml` 的文件,无论何时你提交了更改,它都会帮助你自动构建和部署: @@ -114,7 +114,7 @@ pages: ## Netlify -1. 在 Netlify 中, 创建一个新的 Github 项目,使用以下设置: +1. 在 Netlify 中, 创建一个新的 GitHub 项目,使用以下设置: - **Build Command:** `npm run build:docs` 或者 `yarn build:docs` - **Publish directory:** `docs/.vuepress/dist` @@ -181,7 +181,7 @@ pages: ``` 这里是你项目的配置,请参考 [heroku-buildpack-static](https://github.com/heroku/heroku-buildpack-static) 了解更多。 - + 5. 配置 Heroku 的 git 远程仓库: ``` bash @@ -196,9 +196,9 @@ heroku apps:create example # 为静态网站设置构建包 heroku buildpacks:set https://github.com/heroku/heroku-buildpack-static.git ``` - + 6. 部署你的网站: - + ``` bash # 发布网站 git push heroku master