Skip to content

Changes to steps for publishing GitHub User Page #6095

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

Merged
ianschmitz merged 2 commits into from
Jan 17, 2019
Merged

Changes to steps for publishing GitHub User Page #6095

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
609c985
Changes to steps for publishing GitHub User Page
Dec 27, 2018
431236b
Changed projects to project
Jan 14, 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
15 changes: 8 additions & 7 deletions docusaurus/docs/deployment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,8 @@ To override this, specify the `homepage` in your `package.json`, for example:
This will let Create React App correctly infer the root path to use in the generated HTML file.

**Note**: If you are using `react-router@^4`, you can root `<Link>`s using the `basename` prop on any `<Router>`.<br>
More information [here](https://reacttraining.com/react-router/web/api/BrowserRouter/basename-string).<br>
More information [here](https://reacttraining.com/react-router/web/api/BrowserRouter/basename-string).<br>

<br>
For example:

Expand Down Expand Up @@ -240,7 +241,8 @@ For more information see [Firebase Hosting](https://firebase.google.com/docs/hos

### Step 1: Add `homepage` to `package.json`

**The step below is important!**<br>
**The step below is important!**<br>

**If you skip it, your app will not deploy correctly.**

Open your `package.json` and add a `homepage` field for your project:
Expand Down Expand Up @@ -291,11 +293,10 @@ Add the following scripts in your `package.json`:

The `predeploy` script will run automatically before `deploy` is run.

If you are deploying to a GitHub user page instead of a project page you'll need to make two
additional modifications:
If you are deploying to a GitHub user page instead of a project page you'll need to make one
additional modification:

1. First, change your repository's source branch to be any branch other than **master**.
1. Additionally, tweak your `package.json` scripts to push deployments to **master**:
1. Tweak your `package.json` scripts to push deployments to **master**:

```diff
"scripts": {
Expand All @@ -312,7 +313,7 @@ Then run:
npm run deploy
```

### Step 4: Ensure your project’s settings use `gh-pages`
### Step 4: For a project page, ensure your project’s settings use `gh-pages`

Finally, make sure **GitHub Pages** option in your GitHub project settings is set to use the `gh-pages` branch:

Expand Down
⚡