Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from
Oct 29, 2019
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f02898e
docs: add windows batch instructions for publishing to gh pages
dylmye Oct 29, 2019
2bbe8f9
docs: add windows batch instructions on the v2 website
dylmye Oct 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/getting-started-publishing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,13 +97,19 @@ __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 \
USE_SSH=true \
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 |
Expand Down
8 changes: 7 additions & 1 deletion website/docs/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
```

<!--
Expand Down