Skip to content

Update README.md #26

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #26

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ed18bb
Update README.md
Scyruss Dec 4, 2022
2f8975b
Improve configure gh pages section
NormandErwan Feb 17, 2023
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
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,12 @@ If you're using GitHub:
└── README.md
```

2. Next push on `main` branch will build and deploy your documentation to `https://<USERNAME>.github.io/<REPOSITORY>/`!
2. Commit and push on the `main` branch: your documentation will be built and deployed in the `gh-pages` branch.
3. Configure the Pages of your repository:
- Go to `Settings` > `Pages`.
- Source: select `Deploy from a branch`.
- Branch: select `gh-pages` and `/(root)` and Save.
5. Open `https://<USERNAME>.github.io/<REPOSITORY>/` to see your documentation.

If you're using GitLab, use the provided
[`.gitlab-ci.yml`](https://github.com/NormandErwan/DocFxForUnity/blob/main/.gitlab-ci.yml).
Expand Down Expand Up @@ -158,4 +163,4 @@ details.
## Disclaimer

This repository is not sponsored by or affiliated with Unity Technologies or its affiliates.
“Unity” is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.
“Unity” is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere.