Skip to content

Commit 94b5daa

Browse files
authored
Revise GitHub Pages overview in README.md
Updated the README.md to improve clarity on GitHub Pages features and usage.
1 parent 8057619 commit 94b5daa

1 file changed

Lines changed: 15 additions & 14 deletions

File tree

demos/1_GitHubPagesOverview/README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,25 +10,13 @@ Last updated: 2026-03-26
1010

1111
> **GitHub Pages** is a feature provided by GitHub that allows you to `host static websites directly from a GitHub repository`. It's a great way to showcase your projects, create personal websites, or host documentation for your repositories. `That means it serves whatever files you put in your repository, without running backend code.`
1212
13-
> [!TIP]
14-
> What is GitHub Pages? <br/>
15-
> GitHub Pages is a `free service that turns your GitHub repositories into websites`. You can host HTML, CSS, and JavaScript files, and it’s perfect for static websites that `don’t require server-side processing`. GitHub Pages supports custom domains, making it easy to create a professional-looking website.
16-
17-
- Markdown (.md) → converted to HTML automatically if you use Jekyll.
18-
- HTML, CSS, JavaScript → served directly as static files.
19-
- Jekyll templates (Liquid) → processed by GitHub Pages if you keep Jekyll enabled.
20-
- Static assets → images, fonts, PDFs, JSON, etc.
21-
22-
> [!NOTE]
23-
> - If you need dynamic behavior, you can use JavaScript frameworks (React, Vue, Angular) that compile down to static files and deploy them to GitHub Pages.
24-
> - For backend logic, you’d need to connect to external APIs or use another service (like Firebase, Supabase, or a traditional server).
25-
2613
<details>
2714
<summary><b>List of References</b> (Click to expand)</summary>
2815

2916
- [Websites for you and your projects](https://pages.github.com/)
3017
- [Essentials of automated application deployment with GitHub Actions and GitHub Pages](https://resources.github.com/learn/pathways/automation/essentials/automated-application-deployment-with-github-actions-and-pages/)
31-
18+
- [Microsoft Cloud Sandbox - Unofficial](https://microsoftcloudessentials-learninghub.github.io/org-catalog/) One example was a catalog that aggregated multiple repositories from my GitHub organization. The idea behind it was to create a user‑friendly page that listed all repositories hosted within the organization, while also allowing them to be filtered based on GitHub metadata by [Org Catalog (GitHub Pages)](https://github.com/MicrosoftCloudEssentials-LearningHub/org-catalog)
19+
- [TechWorkshop L300: Win the database acceleration](https://microsoft.github.io/TechExcel-Win-the-Database-Platform/) Example of Workshops documented using GitHub Pages
3220

3321
</details>
3422

@@ -43,6 +31,19 @@ Last updated: 2026-03-26
4331

4432
</details>
4533

34+
> [!TIP]
35+
> What is GitHub Pages? <br/>
36+
> GitHub Pages is a `free service that turns your GitHub repositories into websites`. You can host HTML, CSS, and JavaScript files, and it’s perfect for static websites that `don’t require server-side processing`. GitHub Pages supports custom domains, making it easy to create a professional-looking website.
37+
38+
- Markdown (.md) → converted to HTML automatically if you use Jekyll.
39+
- HTML, CSS, JavaScript → served directly as static files.
40+
- Jekyll templates (Liquid) → processed by GitHub Pages if you keep Jekyll enabled.
41+
- Static assets → images, fonts, PDFs, JSON, etc.
42+
43+
> [!NOTE]
44+
> - If you need dynamic behavior, you can use JavaScript frameworks (React, Vue, Angular) that compile down to static files and deploy them to GitHub Pages.
45+
> - For backend logic, you’d need to connect to external APIs or use another service (like Firebase, Supabase, or a traditional server).
46+
4647
## How is GitHub Pages Used?
4748
- **Personal Websites**: Showcase your portfolio, resume, or blog.
4849
- **Project Documentation**: Host documentation for your open-source projects.

0 commit comments

Comments
 (0)