3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-31 23:40:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(v2): add windows batch instructions for publishing to gh pages (#1914)

Browse source 
* docs: add windows batch instructions for publishing to gh pages

* docs: add windows batch instructions on the v2 website
This commit is contained in:
Dylan Myers 2019-10-29 16:49:01 +00:00 • committed by Endi
parent a8826b98b3
commit f853171791
2 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/getting-started-publishing.md
View file

@ -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=<GIT_USER> \
CURRENT_BRANCH=master \
@ -104,6 +105,11 @@ GIT_USER=<GIT_USER> \
yarn run publish-gh-pages # or `npm run publish-gh-pages`
```
**Windows**
```batch
cmd /C "set GIT_USER=<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 |

8
website/docs/deployment.md
View file

@ -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=<GITHUB_USERNAME> yarn run deploy
GIT_USER=<GITHUB_USERNAME> yarn deploy
```
**Windows**
```batch
cmd /C "set GIT_USER=<GITHUB_USERNAME> && yarn deploy"
```
<!--