diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
index 49bbc14..aa1db32 100644
--- a/.github/workflows/gh-pages.yml
+++ b/.github/workflows/gh-pages.yml
@@ -12,7 +12,7 @@ jobs:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v4
with:
submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
@@ -20,10 +20,11 @@ jobs:
- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
with:
- hugo-version: '0.88.1'
+ hugo-version: 'latest'
+ extended: true
- name: Cache Hugo resources
- uses: actions/cache@v3
+ uses: actions/cache@v4
with:
path: resources
key: ${{ runner.os }}-hugoresources-${{ hashFiles('**/config.toml') }}
@@ -34,7 +35,7 @@ jobs:
run: hugo --gc --minify
- name: Deploy
- uses: peaceiris/actions-gh-pages@v3
+ uses: peaceiris/actions-gh-pages@v4
if: ${{ github.ref == 'refs/heads/main' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
index 1f29da1..0bb16dc 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
/public/
+/resources/
/.idea
*.iml
.hugo_build.lock
diff --git a/LICENSE b/LICENSE
index e1fd273..567db63 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,21 +1,201 @@
-MIT License
-
-Copyright (c) 2023
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [Year] [Owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/README.md b/README.md
index 76ae9cc..8f11040 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,42 @@
-# githubpages
+# Hugo GitHub Pages Template
-This repository is a simple example of a Hugo site that can be deployed with GitHub Pages. Treat it as a template to build your own site. The live example is available at .
+This repository is a template for building a Hugo site deployed with GitHub Pages.
+## Getting Started
-## Requirements
+1. Click the **"Use this template"** button to create a new repository from this template.
+2. Clone your new repository to your local machine.
+3. Install [Hugo](https://gohugo.io/) (Extended version recommended).
-- [Hugo](https://gohugo.io/) static site generator must be installed. On Ubuntu
- you can install it with `apt-get install hugo` or download a binary from the
- [Hugo releases page](https://github.com/gohugoio/hugo/releases).
+## Configuration
-## Running the site locally
+Update `config.toml` with your site details:
-Run the following command in the repository root to start a development server:
+- `baseURL`: Set this to your GitHub Pages URL (e.g., `https://.github.io//`).
+- `title`: Your site title.
+- `params.author`: Your name.
+
+## Running Locally
+
+Run the following command to start a development server:
```bash
hugo server
```
-The site will be served at by default.
+The site will be available at .
+
+## Deployment
+
+This repository includes a GitHub Actions workflow (`.github/workflows/gh-pages.yml`) that automatically deploys your site to the `gh-pages` branch when you push to `main`.
+
+Ensure you have GitHub Pages enabled in your repository settings:
+- Source: Deploy from a branch
+- Branch: `gh-pages` / `/ (root)`
-## Repository structure
+## Repository Structure
-- `content/` – Markdown files that make up the site content.
-- `themes/` – Custom themes used by the site.
-- `archetypes/` – Templates for new content.
-- `config.toml` – Main configuration file.
-
-Feel free to fork this repository as a starting template for your own Hugo + GitHub Pages site.
+- `content/`: Markdown files for your site content.
+- `themes/basic/`: The default theme. You can modify this or install a new theme.
+- `archetypes/`: Templates for new content.
+- `config.toml`: Main configuration file.
diff --git a/config.toml b/config.toml
index 1429fec..b4eaebd 100644
--- a/config.toml
+++ b/config.toml
@@ -1,11 +1,10 @@
-baseURL = 'https://arran4.github.io/githubpages/'
+baseURL = 'https://arran4.github.io/githubpages/' # Update this to your site's URL
languageCode = 'en-us'
defaultContentLanguage = 'en'
-title = 'Arrans Github Pages'
-theme = 'arranstheme'
+title = 'Hugo GitHub Pages Template'
+theme = 'basic'
paginate = 10
uglyURLs = true
[params]
- author = 'Arran'
-
+ author = 'Me'
diff --git a/content/_index.md b/content/_index.md
index e18b141..909ea02 100644
--- a/content/_index.md
+++ b/content/_index.md
@@ -1,9 +1,9 @@
---
-title: "Arran's Github Pages"
+title: "Hugo GitHub Pages Template"
date: 2021-09-11T11:50:17+10:00
draft: false
tags: ['sample']
categories: ['sample-pages']
---
-Hi, this is my humble example github page using hugo.
\ No newline at end of file
+This is a template repository for building a static site with Hugo and deploying it to GitHub Pages.
diff --git a/themes/arranstheme/archetypes/default.md b/themes/basic/archetypes/default.md
similarity index 100%
rename from themes/arranstheme/archetypes/default.md
rename to themes/basic/archetypes/default.md
diff --git a/themes/arranstheme/layouts/404.html b/themes/basic/layouts/404.html
similarity index 100%
rename from themes/arranstheme/layouts/404.html
rename to themes/basic/layouts/404.html
diff --git a/themes/arranstheme/layouts/_default/baseof.html b/themes/basic/layouts/_default/baseof.html
similarity index 100%
rename from themes/arranstheme/layouts/_default/baseof.html
rename to themes/basic/layouts/_default/baseof.html
diff --git a/themes/arranstheme/layouts/_default/list.html b/themes/basic/layouts/_default/list.html
similarity index 100%
rename from themes/arranstheme/layouts/_default/list.html
rename to themes/basic/layouts/_default/list.html
diff --git a/themes/arranstheme/layouts/_default/single.html b/themes/basic/layouts/_default/single.html
similarity index 100%
rename from themes/arranstheme/layouts/_default/single.html
rename to themes/basic/layouts/_default/single.html
diff --git a/themes/arranstheme/layouts/index.html b/themes/basic/layouts/index.html
similarity index 100%
rename from themes/arranstheme/layouts/index.html
rename to themes/basic/layouts/index.html
diff --git a/themes/arranstheme/layouts/partials/footer.html b/themes/basic/layouts/partials/footer.html
similarity index 100%
rename from themes/arranstheme/layouts/partials/footer.html
rename to themes/basic/layouts/partials/footer.html
diff --git a/themes/arranstheme/layouts/partials/head.html b/themes/basic/layouts/partials/head.html
similarity index 100%
rename from themes/arranstheme/layouts/partials/head.html
rename to themes/basic/layouts/partials/head.html
diff --git a/themes/arranstheme/layouts/partials/head_includes.html b/themes/basic/layouts/partials/head_includes.html
similarity index 100%
rename from themes/arranstheme/layouts/partials/head_includes.html
rename to themes/basic/layouts/partials/head_includes.html
diff --git a/themes/arranstheme/layouts/partials/header.html b/themes/basic/layouts/partials/header.html
similarity index 100%
rename from themes/arranstheme/layouts/partials/header.html
rename to themes/basic/layouts/partials/header.html
diff --git a/themes/arranstheme/layouts/partials/meta.html b/themes/basic/layouts/partials/meta.html
similarity index 100%
rename from themes/arranstheme/layouts/partials/meta.html
rename to themes/basic/layouts/partials/meta.html
diff --git a/themes/arranstheme/layouts/post/list.html b/themes/basic/layouts/post/list.html
similarity index 100%
rename from themes/arranstheme/layouts/post/list.html
rename to themes/basic/layouts/post/list.html
diff --git a/themes/arranstheme/layouts/post/single.html b/themes/basic/layouts/post/single.html
similarity index 100%
rename from themes/arranstheme/layouts/post/single.html
rename to themes/basic/layouts/post/single.html
diff --git a/themes/arranstheme/theme.toml b/themes/basic/theme.toml
similarity index 55%
rename from themes/arranstheme/theme.toml
rename to themes/basic/theme.toml
index f5e422e..bf31c8f 100644
--- a/themes/arranstheme/theme.toml
+++ b/themes/basic/theme.toml
@@ -1,15 +1,15 @@
# theme.toml template for a Hugo theme
# See https://github.com/gohugoio/hugoThemes#themetoml for an example
-name = "Arranstheme"
-description = "A minimal Hugo theme used for Arran Ubels' GitHub Pages"
-tags = ["minimal", "example", "personal", "blog"]
+name = "Basic"
+description = "A minimal Hugo theme"
+tags = ["minimal", "example", "blog"]
features = ["basic layout"]
min_version = "0.41.0"
[author]
- name = "Arran Ubels"
- homepage = "https://arran4.github.io"
+ name = "User"
+ homepage = ""
# If porting an existing theme
[original]