Skip to content

Commit ea83469

Browse files
authored
Enhance README with GitHub Pages information
Added details about GitHub Pages features and usage.
1 parent 3e2c6b3 commit ea83469

1 file changed

Lines changed: 15 additions & 4 deletions

File tree

demos/1_GitHubPagesOverview/README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,28 @@ Last updated: 2025-08-04
88

99
----------------------
1010

11-
> **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.
11+
> **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.`
12+
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).
1225
1326
<details>
1427
<summary><b>List of References</b> (Click to expand)</summary>
1528

1629
- [Websites for you and your projects](https://pages.github.com/)
1730
- [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/)
1831

32+
1933
</details>
2034

2135
<details>
@@ -29,9 +43,6 @@ Last updated: 2025-08-04
2943

3044
</details>
3145

32-
> What is GitHub Pages? <br/>
33-
> 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.
34-
3546
## How is GitHub Pages Used?
3647
- **Personal Websites**: Showcase your portfolio, resume, or blog.
3748
- **Project Documentation**: Host documentation for your open-source projects.

0 commit comments

Comments
 (0)