Skip to content

Commit 3bb84be

Browse files
added documentation to have multiple github pages for multiple repo
1 parent f61d2b7 commit 3bb84be

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

src/components/about-us/about-us.tsx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,26 @@ export class AboutUs {
4646
<p>GitHub Pages will look for an index.html , index.md , or README.md file as the entry file for your site. </p>
4747
<p>For this convert an existing repo into Github Pages (or) create a new public repository named <b>username.github.io</b>, where username is your username (or organization name) on GitHub.</p>
4848
<p><a href="https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site">Source</a></p>
49+
<h1>Multiple Github pages for multiple repositories</h1>
50+
<p>In addition to the user/organization site, you can also have project sites for any other repository. The URL for each of these will be in the format https://<b>username</b>.github.io/repository-name.</p><p>
51+
<ul><li> You can create as many project repositories as you like and enable GitHub Pages on them individually.</li><li>
52+
For each repository, you can enable GitHub Pages under the repository's settings, selecting a branch to host the site (typically main or gh-pages).</li></ul>
53+
<br></br>Example Setup:<br></br>
54+
1. Repository 1 (repo1):<br></br>
55+
<ul><li> GitHub Pages URL: https://username.github.io/repo1</li><li>
56+
You can configure this repository to host a website by enabling GitHub Pages in the repository's settings.</li></ul><br></br>
57+
2. Repository 2 (repo2):
58+
<ul><li>GitHub Pages URL: https://username.github.io/repo2</li><li>
59+
Similarly, you can enable GitHub Pages on this repository, and it will host a different website.</li></ul><br></br>
60+
How to set up GitHub Pages for a project repository:<br></br>
61+
<ol><li> Go to the repository you want to use for GitHub Pages.</li>
62+
<li> In the repository, go to Settings then Pages (located under the "Code and automation" section).</li>
63+
<li>Select the branch you want to use for the Pages site (usually main or gh-pages).</li>
64+
<li>Choose the folder (like /root or /docs) or "GitHub Actions and workflow" whichever if applicable.</li>
65+
<li>Save the settings, and your site will be live at https://username.github.io/repository-name.</li></ol><br></br>
66+
This way, you can have multiple repositories, each with its own GitHub Pages site.
67+
68+
</p>
4969
<h1>GitHub Actions</h1>
5070
<p>GitHub Actions is required in scenario where entry file of a repository is not at root directory and the repository is of a framework like React, Angular, StencilJS</p>
5171
<p>GitHub Actions is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline. You can create workflows that build and test every pull request to your repository, or deploy merged pull requests to production.</p>

0 commit comments

Comments
 (0)