Skip to content

Commit 803946f

Browse files
Steven Tanianschmitz
Steven Tan
authored andcommitted
Changes to steps for publishing GitHub User Page (#6095)
* Changes to steps for publishing GitHub User Page Remove the the step for switching to gh-pages branch as it is no longer a viable option. * Changed projects to project
1 parent 34e5029 commit 803946f

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

docusaurus/docs/deployment.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,8 @@ To override this, specify the `homepage` in your `package.json`, for example:
106106
This will let Create React App correctly infer the root path to use in the generated HTML file.
107107

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

@@ -240,7 +241,8 @@ For more information see [Firebase Hosting](https://firebase.google.com/docs/hos
240241
241242
### Step 1: Add `homepage` to `package.json`
242243
243-
**The step below is important!**<br>
244+
**The step below is important!**<br>
245+
244246
**If you skip it, your app will not deploy correctly.**
245247
246248
Open your `package.json` and add a `homepage` field for your project:
@@ -291,11 +293,10 @@ Add the following scripts in your `package.json`:
291293
292294
The `predeploy` script will run automatically before `deploy` is run.
293295
294-
If you are deploying to a GitHub user page instead of a project page you'll need to make two
295-
additional modifications:
296+
If you are deploying to a GitHub user page instead of a project page you'll need to make one
297+
additional modification:
296298

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

300301
```diff
301302
"scripts": {
@@ -312,7 +313,7 @@ Then run:
312313
npm run deploy
313314
```
314315
315-
### Step 4: Ensure your project’s settings use `gh-pages`
316+
### Step 4: For a project page, ensure your project’s settings use `gh-pages`
316317
317318
Finally, make sure **GitHub Pages** option in your GitHub project settings is set to use the `gh-pages` branch:
318319

0 commit comments

Comments
 (0)