This repository hosts the source code for my personal blog. It is powered by Hugo and PaperMod.
You can access the website at: https://oliverlabs.co.uk/.
Before proceeding please ensure you have installed Hugo. You can use GitHub Codespaces or the devcontainer with Docker and VSCode to get started.
Requirements:
- NodeJS (v20)
- Hugo (v0.120.4)
Once setup, run the following commands from the root repository folder:
-
Update the PaperMod theme with the following command after cloning the repository:
git submodule update --init --recursive
-
To run a development server use the following command:
hugo server -D
To build a static website run the following command:
hugo build --minify
Website should be accessible from: http://localhost:1313
- Fork this repo
- Edit the
config.yml
file and enter your preferred parameters - Go to "Settings > Pages", select "GitHub Actions" for the "Source" dropdown
- Go to "Actions", rerun the failed workflow
- Your site should be available at
https://$USERNAME.github.io/
.
.
├── archetypes
│ └── default.md
├── assets
│ └── css
│ └── extended
│ └── custom.css
├── config.yml # Site-wide configuration file
├── content
│ ├── archive.md
│ ├── posts # All blog posts
│ │ ├── 2024-01-01.md
│ │ ├── 2024-01-02.md
│ │ ├── 2024-01-03.md
│ │ ├── first.md
│ │ └── test.md
│ ├── search.md
│ └── tags
│ └── _index.md
├── layouts
│ └── partials
│ ├── comments.html
│ └── header.html
├── LICENCE
├── README.md
├── static # Images, favicons, etc.
│ ├── apple-touch-icon.png
│ ├── favicon-16x16.png
│ ├── favicon-32x32.png
│ ├── favicon.ico
│ ├── logo_outlined_6.png
│ └── safari-pinned-tab.svg
└── themes
└── PaperMod
This project is licensed under the GPL-3.0 license. See the file LICENSE
for more information.
If you plan to use any part of this source code in your website/portfolio, I would be really grateful if you include some form of credit somewhere.