From f853171791e5a87e76ecc9a7538736066d04f84f Mon Sep 17 00:00:00 2001 From: Dylan Myers Date: Tue, 29 Oct 2019 16:49:01 +0000 Subject: [PATCH] docs(v2): add windows batch instructions for publishing to gh pages (#1914) * docs: add windows batch instructions for publishing to gh pages * docs: add windows batch instructions on the v2 website --- docs/getting-started-publishing.md | 6 ++++++ website/docs/deployment.md | 8 +++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/getting-started-publishing.md b/docs/getting-started-publishing.md index 90ee88864f..9ad308c983 100644 --- a/docs/getting-started-publishing.md +++ b/docs/getting-started-publishing.md @@ -97,6 +97,7 @@ __Note:__ Not setting the `url` and `baseUrl` of your project might result in in To run the script directly from the command-line, you can use the following, filling in the parameter values as appropriate. +**Bash** ```bash GIT_USER= \ CURRENT_BRANCH=master \ @@ -104,6 +105,11 @@ GIT_USER= \ yarn run publish-gh-pages # or `npm run publish-gh-pages` ``` +**Windows** +```batch +cmd /C "set GIT_USER= && set CURRENT_BRANCH=master && set USE_SSH=true && yarn run publish-gh-pages" +``` + There are also two optional parameters that are set as environment variables: | Name | Description | diff --git a/website/docs/deployment.md b/website/docs/deployment.md index 4c15a35bb2..f2234f89de 100644 --- a/website/docs/deployment.md +++ b/website/docs/deployment.md @@ -86,8 +86,14 @@ There are two more optional parameters that are set as environment variables: Finally, to deploy your site to GitHub Pages, run: +**Bash** ```bash -GIT_USER= yarn run deploy +GIT_USER= yarn deploy +``` + +**Windows** +```batch +cmd /C "set GIT_USER= && yarn deploy" ```