From bd3aa151a0e2aec8145182a5f880bb628ed87597 Mon Sep 17 00:00:00 2001 From: xdvrx1 Date: Wed, 10 Mar 2021 09:54:23 +0800 Subject: [PATCH 01/30] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6935fd5..dcc6223 100644 --- a/README.md +++ b/README.md @@ -218,7 +218,7 @@ and it will continue to be relevant. I just realized that blogging is not dead because not all the contents can be done through video presentations. -Others really need to be written. +Others should be written. Say, other tutorials are best done through video presentations just like From 8d839bcaeafa08d68a13389a1e41e64002b7ffa3 Mon Sep 17 00:00:00 2001 From: xdvrx1 Date: Sat, 17 Apr 2021 12:17:22 +0800 Subject: [PATCH 02/30] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index ba28f81..6c850a1 100644 --- a/README.md +++ b/README.md @@ -186,7 +186,9 @@ the pages, either from: > - `main` (default) > - `gh-pages` > - `/docs` + + > 5. And select a theme also if you want. > > 6. You visit the site provided. You now have your web page. From 725c4087c3fe2ece68ffcdf80408e27139787e6c Mon Sep 17 00:00:00 2001 From: xdvrx1 Date: Sat, 17 Apr 2021 12:25:50 +0800 Subject: [PATCH 03/30] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6c850a1..18b93c1 100644 --- a/README.md +++ b/README.md @@ -186,9 +186,9 @@ the pages, either from: > - `main` (default) > - `gh-pages` > - `/docs` - +> - +> > 5. And select a theme also if you want. > > 6. You visit the site provided. You now have your web page. From aec95e3108932943a8b752a0399788f0c8befd4b Mon Sep 17 00:00:00 2001 From: xdvrx1 Date: Sat, 17 Apr 2021 12:32:18 +0800 Subject: [PATCH 04/30] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 18b93c1..e31b375 100644 --- a/README.md +++ b/README.md @@ -187,7 +187,7 @@ the pages, either from: > - `gh-pages` > - `/docs` > - +> > > 5. And select a theme also if you want. > From 0c46ef390c403b268ac824215d89d4d7239db7a6 Mon Sep 17 00:00:00 2001 From: xdvrx1 Date: Sat, 17 Apr 2021 12:41:26 +0800 Subject: [PATCH 05/30] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index e31b375..eed20d7 100644 --- a/README.md +++ b/README.md @@ -183,12 +183,11 @@ at the left side, it's just `Pages`. > > 4. Select where GitHub Pages should build the pages, either from: + > - `main` (default) > - `gh-pages` > - `/docs` > -> -> > 5. And select a theme also if you want. > > 6. You visit the site provided. You now have your web page. From db481a3274738c6820ea6dd7ba620a440e1fff18 Mon Sep 17 00:00:00 2001 From: jdevstatic Date: Thu, 21 Apr 2022 23:22:02 +0800 Subject: [PATCH 06/30] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index eed20d7..4983ca3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # GitHub Pages Tutorial + +*`updated 21 April 2022`* + [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fxdvrx1%2Fgithub-pages-tutorial&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=PAGE+VIEWS&edge_flat=false)](https://hits.seeyoufarm.com) ## GitHub Pages From dfe39c7505415b3194e9fed2ba75cb1432092bfa Mon Sep 17 00:00:00 2001 From: jdevstatic Date: Thu, 21 Apr 2022 23:26:28 +0800 Subject: [PATCH 07/30] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 4983ca3..a227560 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # GitHub Pages Tutorial -*`updated 21 April 2022`* [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fxdvrx1%2Fgithub-pages-tutorial&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=PAGE+VIEWS&edge_flat=false)](https://hits.seeyoufarm.com) From c2eeedb670c149139d15057a45aee21888390af8 Mon Sep 17 00:00:00 2001 From: jdevstatic Date: Thu, 21 Apr 2022 23:27:20 +0800 Subject: [PATCH 08/30] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a227560..4983ca3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # GitHub Pages Tutorial +*`updated 21 April 2022`* [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fxdvrx1%2Fgithub-pages-tutorial&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=PAGE+VIEWS&edge_flat=false)](https://hits.seeyoufarm.com) From 01ff9a30db5a600db1c28e216566f51170ee2d7f Mon Sep 17 00:00:00 2001 From: jdevstatic Date: Sat, 4 Jun 2022 18:27:16 +0800 Subject: [PATCH 09/30] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4983ca3..d2c283b 100644 --- a/README.md +++ b/README.md @@ -204,9 +204,9 @@ The trick is actually the code: if that is purely JavaScript, then it will work. To prove this, I deployed demo games from Vanilla Web Projects using GitHub Pages: - + - + As you can see here, because of the pure JavaScript, it enables the site not to be static. Remember, @@ -265,7 +265,7 @@ differs from WordPress: For my very own example, this site - + was built by GitHub Pages, Jekyll being the static site generator. From c2cf8abbc28c8d8a4fba0fcf25237ad9d9237828 Mon Sep 17 00:00:00 2001 From: jdevstatic Date: Sun, 28 May 2023 15:02:10 +0800 Subject: [PATCH 10/30] Update README.md --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d2c283b..f210b65 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # GitHub Pages Tutorial -*`updated 21 April 2022`* +*`updated 28 May 2023`* [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fxdvrx1%2Fgithub-pages-tutorial&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=PAGE+VIEWS&edge_flat=false)](https://hits.seeyoufarm.com) @@ -283,3 +283,21 @@ About custom domain in GitHub Pages: + +## More Of My Topics + +#### + +#### + +#### + +#### + +#### + +#### + +#### + +#### From 2bf24e4744fd5655ee85546b59b9fb439cf51de9 Mon Sep 17 00:00:00 2001 From: jdevstatic Date: Sun, 28 May 2023 15:03:25 +0800 Subject: [PATCH 11/30] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f210b65..a59c235 100644 --- a/README.md +++ b/README.md @@ -288,7 +288,7 @@ About custom domain in GitHub Pages: #### -#### +#### #### From 7bf186865a5995f0fff78ef28ff6f9bb6fc2879c Mon Sep 17 00:00:00 2001 From: jdevstatic Date: Tue, 9 Apr 2024 00:36:20 +0800 Subject: [PATCH 12/30] Create FUNDING.yml --- .github/FUNDING.yml | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..9e50aa4 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: jdevstatic From e52a21116b7c2af914d39cbf1ea2fcb5b8252ebd Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Sun, 21 Jul 2024 20:01:43 +0800 Subject: [PATCH 13/30] Update README.md --- README.md | 53 +++++++++++++++++++++++++++-------------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index a59c235..963de43 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,33 @@ will still be correct. As you can see, it's very practical. -## How To +## Easy Steps +> So, the steps are: +> +> 1. Create a GitHub account if there is none. +> +> 2. Create a repository or use an existing one. +For free accounts, GitHub does not allow you +to host from a private repo. +> +> 3. Go to `Settings` and look for GitHub Pages +at the left side, it's just `Pages`. +> +> 4. Set Up GitHub Pages: +> - Click `None` to trigger the dropdown. +> - Select `main` from the dropdown; it will auto-select `/root`. Leave it as is. +> - Click "Save" to apply your changes. +> +> +> 5. Configure Your Site: +> - Go back to your repository. +> - Create a file named `_config.yml`. +> - Choose a theme provided by GitHub. For example:
+> ![Theme Selection](https://github.com/user-attachments/assets/08f71705-e35c-4fd2-b018-7b0925bfa3d2) +> +> 6. You visit the site provided. You now have your web page. + +## More Details In the same way you keep your pages and assets in one directory and subdirectories on the server, it is the same thing on GitHub Pages through a GitHub repository. @@ -172,31 +198,6 @@ layout: default on top of the HTML file. -*** -> So, the steps are: -> -> 1. Create a GitHub account if there is none. -> -> 2. Create a repository or use an existing one. -For free accounts, GitHub does not allow you -to host from a private repo. -> -> 3. Go to `Settings` and look for GitHub Pages -at the left side, it's just `Pages`. -> -> 4. Select where GitHub Pages should build -the pages, either from: - -> - `main` (default) -> - `gh-pages` -> - `/docs` -> -> 5. And select a theme also if you want. -> -> 6. You visit the site provided. You now have your web page. - -*** - ## The Trick GitHub Pages generates a static site but don't you know that you can deploy games using this? From 05fe0bc8a9967983871fd597a67b898ae6cceb53 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Sun, 21 Jul 2024 21:57:18 +0800 Subject: [PATCH 14/30] Update README.md --- README.md | 49 +++++++++++++++++++++++++++---------------------- 1 file changed, 27 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 963de43..490967c 100644 --- a/README.md +++ b/README.md @@ -75,31 +75,36 @@ will still be correct. As you can see, it's very practical. -## Easy Steps -> So, the steps are: -> -> 1. Create a GitHub account if there is none. -> -> 2. Create a repository or use an existing one. +## Easy Way +So, the steps are: + +1. Create a GitHub account if there is none. + +2. Create a repository or use an existing one. For free accounts, GitHub does not allow you to host from a private repo. -> -> 3. Go to `Settings` and look for GitHub Pages + +3. Initialize the repo with a README.md or create +one if there was none. This will be the file that +will be turned as the landing Page if there is no +other file to be served. + +4. Go to `Settings` and look for GitHub Pages at the left side, it's just `Pages`. -> -> 4. Set Up GitHub Pages: -> - Click `None` to trigger the dropdown. -> - Select `main` from the dropdown; it will auto-select `/root`. Leave it as is. -> - Click "Save" to apply your changes. -> -> -> 5. Configure Your Site: -> - Go back to your repository. -> - Create a file named `_config.yml`. -> - Choose a theme provided by GitHub. For example:
-> ![Theme Selection](https://github.com/user-attachments/assets/08f71705-e35c-4fd2-b018-7b0925bfa3d2) -> -> 6. You visit the site provided. You now have your web page. + +5. Set Up GitHub Pages: + - Click `None` to trigger the dropdown. + - Select `main` from the dropdown; it will auto-select `/root`. Leave it as is. + - Click "Save" to apply your changes. + + +6. Configure Your Site: + - Go back to your repository. + - Create a file named `_config.yml`. + - Choose a theme provided by GitHub. For example:
+ ![Theme Selection](https://github.com/user-attachments/assets/08f71705-e35c-4fd2-b018-7b0925bfa3d2) + +7. You visit the site provided. You now have your web page. ## More Details In the same way you keep your pages and assets in one From 19072a89b99fccc52dc96efbf20ff06f6b4e1150 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Sun, 21 Jul 2024 22:06:58 +0800 Subject: [PATCH 15/30] Update README.md --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 490967c..282093a 100644 --- a/README.md +++ b/README.md @@ -75,36 +75,33 @@ will still be correct. As you can see, it's very practical. -## Easy Way -So, the steps are: - +## GitHub Pages The Easy Way 1. Create a GitHub account if there is none. 2. Create a repository or use an existing one. For free accounts, GitHub does not allow you to host from a private repo. -3. Initialize the repo with a README.md or create -one if there was none. This will be the file that -will be turned as the landing Page if there is no -other file to be served. +3. Initialize the repo with a README.md, or create one if +it doesn't exist. This file will serve as the landing page +if there are no other files to be served. -4. Go to `Settings` and look for GitHub Pages +4. Go to `Settings` of the repository and look for GitHub Pages at the left side, it's just `Pages`. - -5. Set Up GitHub Pages: - Click `None` to trigger the dropdown. - - Select `main` from the dropdown; it will auto-select `/root`. Leave it as is. + - Select `main` from the dropdown, it will auto-select `/root`. Leave it as is. - Click "Save" to apply your changes. -6. Configure Your Site: +5. Configure Your Site: - Go back to your repository. - Create a file named `_config.yml`. - Choose a theme provided by GitHub. For example:
![Theme Selection](https://github.com/user-attachments/assets/08f71705-e35c-4fd2-b018-7b0925bfa3d2) -7. You visit the site provided. You now have your web page. +6. Visit the site provided. The URL pattern for GitHub Pages sites +typically follows this format: `https://.github.io//`. +You now have your web page. ## More Details In the same way you keep your pages and assets in one From a68fbacc580da56a2d20ecc3eaa6464a349f5421 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Sun, 21 Jul 2024 22:08:42 +0800 Subject: [PATCH 16/30] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 282093a..82a7aa4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # GitHub Pages Tutorial -*`updated 28 May 2023`* +*`updated July 7, 2024`* [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fxdvrx1%2Fgithub-pages-tutorial&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=PAGE+VIEWS&edge_flat=false)](https://hits.seeyoufarm.com) From bf5fa5073c4bf27718df70783b1bf863fa9a04ad Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Sun, 21 Jul 2024 22:22:38 +0800 Subject: [PATCH 17/30] Update README.md --- README.md | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 82a7aa4..acf291d 100644 --- a/README.md +++ b/README.md @@ -82,9 +82,19 @@ As you can see, it's very practical. For free accounts, GitHub does not allow you to host from a private repo. -3. Initialize the repo with a README.md, or create one if -it doesn't exist. This file will serve as the landing page -if there are no other files to be served. +3. Initialize the repo with a `README.md`, or create one if it doesn't + exist. This file will serve as the default landing page on GitHub. + Other options include `index.html`, `index.htm` or `index.md`. The + simplest method to create a web page is by using Markdown, but you + also have the option to write in HTML if you prefer. But if you are + writing a content, mostly you will use Markdown more than HTML. + + Note: While you can technically have `README.md`, `index.html`, + `index.htm` and `index.md` in your repository, it's not standard + practice to include all four. GitHub Pages will prioritize them in + the following order: `index.html`, `index.htm`, `index.md`, and then + `README.md`. It's best to choose one primary file for your landing + page to avoid confusion. 4. Go to `Settings` of the repository and look for GitHub Pages at the left side, it's just `Pages`. From c43ad405c657e0d2be915cbf65c47e2fb218376c Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Sun, 21 Jul 2024 22:48:11 +0800 Subject: [PATCH 18/30] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index acf291d..83c1e20 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,8 @@ at the left side, it's just `Pages`. typically follows this format: `https://.github.io//`. You now have your web page. -## More Details +## More Advanced Details +### GitHub Per User Root In the same way you keep your pages and assets in one directory and subdirectories on the server, it is the same thing on GitHub Pages through a GitHub repository. @@ -125,6 +126,7 @@ so mine is `xdvrx1.github.io`. My site will be automatically created. However, you may skip initializing your root directory. +### Default Documents A default document will be displayed when a visitor requests the site's URL. This is the `index.htm` file (or `index.html` to make sure other platforms will read it correctly) @@ -144,6 +146,7 @@ they are still the choices for the default document. The big advantage of using pure HTML is the freedom to design your page. +### GitHub Directories Where It Will Be Hosting There are three places where GitHub Pages will be building your site from: `main`, `gh-pages` or `/docs`. @@ -182,6 +185,7 @@ you want to build your site from scratch where you don't copy the contents of the `main` branch, as in the case of `gh-pages` branch. +### Custom Domain Changing the default address is another story, where you really want to make sure that you have an existing domain. If you know how to host @@ -192,6 +196,7 @@ studying how to host a website from a different source because the idea is the same in GitHub Pages. I provided the link at the bottom. +### Default Themes and Custom Themes The themes provided by GitHub Pages can be used for your pages. These themes will always work in Markdown files From 964ded409d4c2ebd101eeed34fabcd20390d620f Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Sun, 21 Jul 2024 22:58:34 +0800 Subject: [PATCH 19/30] Update README.md --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 83c1e20..9d80278 100644 --- a/README.md +++ b/README.md @@ -198,8 +198,8 @@ I provided the link at the bottom. ### Default Themes and Custom Themes The themes provided by GitHub Pages can be used -for your pages. These themes will -always work in Markdown files +for your pages, just like in our example above. +These themes will always work in Markdown files but when you deal with pure HTML, make sure that you always delete the head section and just include the body so that the theme you selected will @@ -215,6 +215,10 @@ layout: default on top of the HTML file. +For more information on customizing themes, visit the [GitHub Pages Documentation][github-docs]. + +[github-docs]: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll + ## The Trick GitHub Pages generates a static site but don't you know that you can deploy games using this? From ec57b40c9e5c3dca3b8789a2ee3f8549b4cfebe3 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Sun, 21 Jul 2024 23:22:46 +0800 Subject: [PATCH 20/30] Update README.md --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9d80278..4d0cbfd 100644 --- a/README.md +++ b/README.md @@ -114,16 +114,17 @@ typically follows this format: `https://.github.io//`. You now have your web page. ## More Advanced Details -### GitHub Per User Root -In the same way you keep your pages and assets in one -directory and subdirectories on the server, it is -the same thing on GitHub Pages through a GitHub repository. +### GitHub Pages Root Defaults +By default, GitHub provides accounts and even Orgs a root +of your Web Page where all pages will be based from. Even if +you don't initialize this repo, you can start enabling +Pages per repo. For a user, `.github.io` is the pattern by default so that GitHub Pages can build the site. Meaning, you should create a repository named after this pattern, -so mine is `xdvrx1.github.io`. -My site will be automatically created. +so mine is `jdevfullstack.github.io`. You can now +customize your root web page and it will be served by GitHub ! However, you may skip initializing your root directory. ### Default Documents From 9aca1b3c5d8a5396a743b198d2a13e0ade694540 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Sun, 21 Jul 2024 23:46:25 +0800 Subject: [PATCH 21/30] Update README.md --- README.md | 52 +++++++++++++++++++++++++++------------------------- 1 file changed, 27 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 4d0cbfd..9f562db 100644 --- a/README.md +++ b/README.md @@ -128,11 +128,13 @@ customize your root web page and it will be served by GitHub ! However, you may skip initializing your root directory. ### Default Documents -A default document will be displayed when a visitor requests -the site's URL. This is the `index.htm` file (or `index.html` -to make sure other platforms will read it correctly) +As was mentioned above, a default document will +be displayed when a visitor requests +the site's URL. This is the `index.htm` file ( or `index.html` +to make sure other platforms will read it correctly ) unless you change this manually for the server to give a different default document. + It is the same in GitHub Pages plus the `README.md` or `index.md`. So, when you create a repo for GitHub Pages, @@ -147,7 +149,7 @@ they are still the choices for the default document. The big advantage of using pure HTML is the freedom to design your page. -### GitHub Directories Where It Will Be Hosting +### GitHub Directories for Hosting There are three places where GitHub Pages will be building your site from: `main`, `gh-pages` or `/docs`. @@ -155,36 +157,36 @@ your site from: `main`, `gh-pages` or `/docs`. branch, there is no additional effort, just set the proper configuration in `Settings`. -- `gh-pages` is a branch, -to create this, go to `Branch`, -type in the box 'gh-pages' -then click the pop-up so that -it will be created. - - `/docs` is a subfolder of the main `branch`, just click `Create new file` then type -'docs/index.htm' or any of the other +`docs/index.htm` or any of the other choices for the default document. -GitHub does not allow empty repository, +GitHub does not allow an empty folder, so you must initialize it with a file. In this example, that is `index.htm`. -Furthermore, as I have observed when using just a regular -account and when there is no need to change the domain name, -it's just a matter of preference and technique where you -will be building your site among the three options. +- `gh-pages` is a branch, +to create this, go to `Branch`, +type in the box `gh-pages` then hit Enter. + +So, what to use ? Here are some considerations: +- if you are creating tutorial like this page of mine +you are reading, simply use the `main` branch using the +`README.md` file. + +- the `/docs` folder is usual for those codebase with +documentation. Other document generator also relies on +this folder. -But there are few considerations: -- First, the `main` branch can be the source when it's all -about building the site. +- the `gh-pages` can be your choice when your `main` +branch is dedicated for your source codes and you want +a dedicated hosting directory -- Second, the `gh-pages` can be your choice when your `main` -branch is dedicated for your source codes. +- the `main` branch can be the source when it's all +about building the site not related to coding, as in +a pure Web Page -- Third, the `/docs` folder is a good choice when -you want to build your site from scratch where -you don't copy the contents of the `main` branch, -as in the case of `gh-pages` branch. +Finally, it's up to the preference of the user or the team. ### Custom Domain Changing the default address is another story, where From c2a4a33c81160b9a9e630a029229c7bd90577638 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Mon, 22 Jul 2024 00:05:46 +0800 Subject: [PATCH 22/30] update README.md --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9f562db..8c0848f 100644 --- a/README.md +++ b/README.md @@ -229,9 +229,9 @@ The trick is actually the code: if that is purely JavaScript, then it will work. To prove this, I deployed demo games from Vanilla Web Projects using GitHub Pages: - + - + As you can see here, because of the pure JavaScript, it enables the site not to be static. Remember, @@ -290,7 +290,7 @@ differs from WordPress: For my very own example, this site - + was built by GitHub Pages, Jekyll being the static site generator. @@ -311,18 +311,18 @@ About custom domain in GitHub Pages: ## More Of My Topics -#### +#### -#### +#### -#### +#### -#### +#### -#### +#### -#### +#### -#### +#### -#### +#### From 88338b6fea77e4a74f67caf406967174b9208579 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Mon, 22 Jul 2024 00:16:28 +0800 Subject: [PATCH 23/30] Update README.md --- README.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8c0848f..5986a40 100644 --- a/README.md +++ b/README.md @@ -229,9 +229,9 @@ The trick is actually the code: if that is purely JavaScript, then it will work. To prove this, I deployed demo games from Vanilla Web Projects using GitHub Pages: - + - + As you can see here, because of the pure JavaScript, it enables the site not to be static. Remember, @@ -290,13 +290,10 @@ differs from WordPress: For my very own example, this site - + was built by GitHub Pages, -Jekyll being the static site generator. -When you click `View on GitHub`, that is the repository -where all the assets and default documents reside. -It's that simple. +Jekyll being the static site generator. It's that simple. And, for those who don't know yet how to host a site using a computer as a server, From 4dc529ebe23188f3d1756fffe01094dab3bf9b9e Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Mon, 22 Jul 2024 00:38:43 +0800 Subject: [PATCH 24/30] Update README.md --- README.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/README.md b/README.md index 5986a40..49d57a5 100644 --- a/README.md +++ b/README.md @@ -295,17 +295,10 @@ For my very own example, this site was built by GitHub Pages, Jekyll being the static site generator. It's that simple. -And, for those who don't know yet how to -host a site using a computer as a server, - - - About custom domain in GitHub Pages: - - ## More Of My Topics #### From 87464d9693c55e83f42e139ed1e452fe9081bd87 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Mon, 22 Jul 2024 01:47:08 +0800 Subject: [PATCH 25/30] Update README.md --- README.md | 43 ++++++++++++++++++++++++++++++------------- 1 file changed, 30 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 49d57a5..5e89d2f 100644 --- a/README.md +++ b/README.md @@ -222,25 +222,42 @@ For more information on customizing themes, visit the [GitHub Pages Documentatio [github-docs]: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll -## The Trick -GitHub Pages generates a static site but -don't you know that you can deploy games using this? -The trick is actually the code: if that is purely -JavaScript, then it will work. To prove this, I deployed +## What Static Site Really Means + +GitHub Pages is known for hosting static sites, but what does "static" really mean? +Does this imply that such sites cannot incorporate dynamic elements through JavaScript? + +The term "static site" refers to the way content is served to the user. In a static +site, all content is pre-generated into HTML files and delivered directly to the +browser. This means there's no server-side processing or database interactions +happening in real-time when a user visits the site. + +However, this doesn't mean static sites are devoid of interactivity or dynamism. +Through client-side JavaScript, static sites can include dynamic behaviors such as +content updates, animations, and interactions. JavaScript can also fetch data from +external APIs, bringing in dynamic content or functionality, albeit without direct +server-side processing or database access on the hosting server. + +The key limitation of static sites, particularly in the context of GitHub Pages, is +the absence of backend functionality. This means while you can fetch and display +data from external sources, you cannot directly save data back to a server or +database through GitHub Pages. Any form of data storage or complex server-side +logic would require external services or APIs. + +In essence, static sites served through GitHub Pages offer a blend of performance +and security for delivering content, with the flexibility to incorporate dynamic +elements via client-side JavaScript, making them suitable for a wide range of +applications from personal blogs to documentation and portfolio websites. +In short, it has its own advantages compared to a full-pledged website. + +GitHub Pages can even host games if the code is purely written in +JavaScript. To prove this, I deployed demo games from Vanilla Web Projects using GitHub Pages: -As you can see here, because of the pure JavaScript, -it enables the site not to be static. Remember, -GitHub is referring to its being static -for the server-side, -so you can't directly run, say, a PHP script. And -since JavaScript is browser-side scripting, it -will work as expected. - ## Blogging Vs Vlogging To my surprise, blogging is not dead. I simply had that conclusion realizing From 2f7161b89888f439128d799d1457d1d54b18d9c3 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Mon, 22 Jul 2024 20:57:09 +0800 Subject: [PATCH 26/30] Update README.md --- README.md | 26 +++++++++----------------- 1 file changed, 9 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 5e89d2f..99e0c17 100644 --- a/README.md +++ b/README.md @@ -259,6 +259,10 @@ demo games from Vanilla Web Projects using GitHub Pages: ## Blogging Vs Vlogging +Just an added section in here since we are +dealing with Markdown and GitHub Pages. +Do you think it's still worth writing ? + To my surprise, blogging is not dead. I simply had that conclusion realizing YouTube is a very successful platform. @@ -316,20 +320,8 @@ About custom domain in GitHub Pages: -## More Of My Topics - -#### - -#### - -#### - -#### - -#### - -#### - -#### - -#### +## More Of My Content +- [jdevfullstack Profile](https://github.com/jdevfullstack) +- [jdevfullstack Repos](https://github.com/jdevfullstack?tab=repositories) +- [jdevfullstack Projects](https://github.com/jdevfullstack-projects) +- [jdevfullstack Tutorials](https://github.com/jdevfullstack-tutorials) From a4273fe9e49f1e45ef668cea41f7275f6485845b Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Thu, 25 Jul 2024 23:27:34 +0800 Subject: [PATCH 27/30] Update README.md --- README.md | 86 ++++++++++++++++++++++++++----------------------------- 1 file changed, 41 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 99e0c17..6bdc99c 100644 --- a/README.md +++ b/README.md @@ -29,51 +29,47 @@ was all about static web pages and we all know the advantages of static pages against dynamic ones. ## Why GitHub Pages? -Ideally, GitHub Pages was intended for a project's -documentation. However, GitHub allowed users to use -it for other purposes within the boundaries given. -For instance, creating a site to promote your business -is not allowed. -But other than those limitations, -you have the option to use GitHub Pages -when you want to display information -and you want to share it to the rest of the world, -just like a blogging site. You can even -add an advertisement and donation button to enable -financial support. - -Remember, when you are creating a digital content, -it's better to use a plaintext file. Markdown is the -best format, as it can simply be turned into -HTML. And as we know, when it's HTML format, that's -the very consumption of web browsers, isn't it? - -This also reinforces the writers to use GitHub -as their development site because it is more -efficient as it uses `git` to record the -file's history. Even if Google Docs has a -similar version tracking, still `git` -cannot be replaced. - -Now, here is the catch: when you want to distribute -your content as hard copy, -in Google Chrome, you can simply -right click the page and click `Print` -you now have the PDF version of your content. -Also, say, you are creating content for another -website, you can simply embed the page and -your job is done. You have the repo as the -active site for its development, maybe, others -will collaborate too, and then the GitHub Pages -generated page as the output. -If ever you need a Google Docs -or Microsoft Word -version of this, simply copy the rendered -Markdown file of GitHub and paste it -on Google Docs or Microsoft Word, the format -will still be correct. - -As you can see, it's very practical. + +Originally, GitHub Pages was intended for a project's +documentation. However, GitHub allows users to use it +for other purposes within certain boundaries. For +instance, creating a site to promote your business is +allowed as long as it complies with GitHub's terms of +service. Aside from those limitations, you have the +option to use GitHub Pages when you want to display +information and share it with the rest of the world, +just like a blogging site. You can even add +advertisements and donation buttons to enable financial +support. + +When creating digital content, it comes in handy to use a +plaintext file. Markdown is an excellent format because +it can easily be converted into HTML, which is the +primary format consumed by web browsers. + +This also encourages writers to use GitHub as their +development site because it is more efficient, +utilizing `git` to record the file's history. While +Google Docs has a similar version tracking feature, +`git` offers more robust version control capabilities. + +Additionally, if you want to distribute your content as +a hard copy, you can simply right-click the page in +Google Chrome and select `Print` to generate a PDF +version of your content. If you are creating content +for another website, you can embed the page, and your +job is done. You have the repository as the active site +for development, potentially with collaboration from +others, and the GitHub Pages generated page as the +output. + +If you need a Google Docs or Microsoft Word version of +your content, you can copy the rendered Markdown file +from GitHub and paste it into Google Docs or Microsoft +Word, and the format will generally remain correct with +some minor adjustments. + +As you can see, using GitHub Pages is very practical. ## GitHub Pages The Easy Way 1. Create a GitHub account if there is none. From e174b4ce5c9cbecd306885faa3022a6d977ed3a0 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Thu, 25 Jul 2024 23:34:19 +0800 Subject: [PATCH 28/30] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6bdc99c..3c65e49 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # GitHub Pages Tutorial -*`updated July 7, 2024`* +*`updated July 25, 2024`* [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fxdvrx1%2Fgithub-pages-tutorial&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=PAGE+VIEWS&edge_flat=false)](https://hits.seeyoufarm.com) From dbd1aadaa5664c116562d6a241589f06e54c0627 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Fri, 26 Jul 2024 19:04:38 +0800 Subject: [PATCH 29/30] Update README.md --- README.md | 51 +++++++++++++++++---------------------------------- 1 file changed, 17 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 3c65e49..f81c38a 100644 --- a/README.md +++ b/README.md @@ -255,40 +255,23 @@ demo games from Vanilla Web Projects using GitHub Pages: ## Blogging Vs Vlogging -Just an added section in here since we are -dealing with Markdown and GitHub Pages. -Do you think it's still worth writing ? - -To my surprise, blogging is not dead. -I simply had that conclusion realizing -YouTube is a very successful platform. -But written content is still not dead -and it will continue to be relevant. - -I just realized that blogging is not -dead because not all the contents -can be done through video presentations. -Others should be written. - -Say, other tutorials are best done -through video presentations just like -bodybuilding demonstrations but -tutorials in tech, particularly just -like the full documentation of -computer languages, are best done through -text. Imagine if you will be doing -all those through video presentations, -first, that is not practical, second -it will take a lot of space and that -will be problematic for poor connection. -And third, it is best done through -writing because the content is too -complex there are several subheadings. - -So, if you will be using GitHub Pages -to create written tutorials, you have -the full advantage of GitHub Pages versus -all those blogging sites. +Just an added section in here since we are dealing with Markdown +and GitHub Pages. Do you think it's still worth writing ? + +We might think blogging is already dead, with all these +video-based platforms like YouTube and now TikTok. There are +even dedicated sites for posting images alone. + +If we compare how popular blogging was in the past versus today, +let's also consider that it was the main platform back then +before the advent of different social media platforms. + +Now, choices are diverse, so it might seem to be a dead platform. +But as you can see, text-based sites are still very strong today. +Digital written content is still popular, even printed books. +Written content is mostly associated with high-quality, in-depth +content. In short, it has its own place in the diverse world of +media consumption. ## Useful Links For further details, it is best to visit GitHub Pages From 520a758a4b6b3865b157566a29a9734e0ac88087 Mon Sep 17 00:00:00 2001 From: jdevfullstack Date: Fri, 26 Jul 2024 19:21:58 +0800 Subject: [PATCH 30/30] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f81c38a..f16033e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # GitHub Pages Tutorial -*`updated July 25, 2024`* +*`updated July 26, 2024`* [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fxdvrx1%2Fgithub-pages-tutorial&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=PAGE+VIEWS&edge_flat=false)](https://hits.seeyoufarm.com)