Skip to content

Commit ad66315

Browse files
committed
Improve configure gh pages section
1 parent 3a7b9f4 commit ad66315

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -123,12 +123,12 @@ If you're using GitHub:
123123
└── README.md
124124
```
125125

126-
2. Next push on `main` branch will build and deploy your documentation to `https://<USERNAME>.github.io/<REPOSITORY>/`!
127-
128-
Note: For the fist time you should confiugre your repository page simply go to
129-
`settings / Pages`<br>
130-
`Source: select Deploy from a branch`<br>
131-
`Branch: select gh-pages, select / (root) path and Save`
126+
2. Commit and push on the `main` branch: your documentation will be built and deployed in the `gh-pages` branch.
127+
3. Configure the Pages of your repository:
128+
- Go to `Settings` > `Pages`.
129+
- Source: select `Deploy from a branch`.
130+
- Branch: select `gh-pages` and `/(root)` and Save.
131+
5. Open `https://<USERNAME>.github.io/<REPOSITORY>/` to see your documentation.
132132

133133
If you're using GitLab, use the provided
134134
[`.gitlab-ci.yml`](https://github.com/NormandErwan/DocFxForUnity/blob/main/.gitlab-ci.yml).

0 commit comments

Comments
 (0)