From 9ed18bb4dcfc0b9c7c98fc813835a1e9d60b140a Mon Sep 17 00:00:00 2001 From: Scyruss <64830174+Scyruss@users.noreply.github.com> Date: Sun, 4 Dec 2022 10:50:05 +0100 Subject: [PATCH 1/2] Update README.md Configure github page with the new branch. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e0e625f..391ce0b 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,11 @@ If you're using GitHub: 2. Next push on `main` branch will build and deploy your documentation to `https://.github.io//`! +Note: For the fist time you should confiugre your repository page simply go to +`settings / Pages`
+`Source: select Deploy from a branch`
+`Branch: select gh-pages, select / (root) path and Save` + If you're using GitLab, use the provided [`.gitlab-ci.yml`](https://github.com/NormandErwan/DocFxForUnity/blob/main/.gitlab-ci.yml). Generated website is pushed to a `public/` directory. See the @@ -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. \ No newline at end of file +“Unity” is a trademark or registered trademark of Unity Technologies or its affiliates in the U.S. and elsewhere. From 2f8975b122e3965d2d3f8e56d2e8a568f4398e43 Mon Sep 17 00:00:00 2001 From: Erwan Normand Date: Fri, 17 Feb 2023 22:01:39 +0100 Subject: [PATCH 2/2] Improve configure gh pages section --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 391ce0b..cdac75e 100644 --- a/README.md +++ b/README.md @@ -123,12 +123,12 @@ If you're using GitHub: └── README.md ``` -2. Next push on `main` branch will build and deploy your documentation to `https://.github.io//`! - -Note: For the fist time you should confiugre your repository page simply go to -`settings / Pages`
-`Source: select Deploy from a branch`
-`Branch: select gh-pages, select / (root) path and Save` +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://.github.io//` 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).