Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stuartmccoll/hugo-theme-refresh
♻️ A simple, light Hugo theme
https://github.com/stuartmccoll/hugo-theme-refresh
hacktoberfest hugo hugo-theme
Last synced: about 1 month ago
JSON representation
♻️ A simple, light Hugo theme
- Host: GitHub
- URL: https://github.com/stuartmccoll/hugo-theme-refresh
- Owner: stuartmccoll
- License: mit
- Created: 2020-05-11T18:56:27.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-04-01T11:21:54.000Z (over 1 year ago)
- Last Synced: 2024-10-13T18:25:08.181Z (2 months ago)
- Topics: hacktoberfest, hugo, hugo-theme
- Language: SCSS
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# hugo-theme-refresh
Refresh is a simple, light, low-code theme designed for blogs running on [Hugo](https://gohugo.io).
## Installation
You'll need to have installed Hugo and created a new site before you can install the theme.
To install Hugo, [follow the official installation guide](https://gohugo.io/getting-started/quick-start/).
Refresh has only been tested on Hugo **v0.75.1**. The theme may fail to compile on lower versions.
### Create a new Hugo site
Use the following command to create a new Hugo site:
```bash
hugo new site mysite
```
### Install the Refresh theme
Navigate to your site's directory.
```bash
cd mysite
```
Use the following command to clone this repository into your Hugo `themes` directory:
```bash
git clone https://github.com/stuartmccoll/hugo-theme-refresh.git
```
### Run Hugo
After an initial install of the theme, generate your Hugo site using this command:
```bash
hugo
```
After this, you can use the following command for local development:
```bash
hugo server
```
Your site will be running locally at `localhost:1313`.
## Configuration
There are a number of configuration settings which should be copied from `example.config.toml` into your local `config.toml`.
The default values in the following should be replaced:
```toml
licenseType = "CC BY 4.0"
licenseLink = "https://creativecommons.org/licenses/by/4.0"
issuesLink = "https://github.com/stuartmccoll/hugo-theme-refresh/issues/new"
mastodonUsername = "@[email protected]"
```
## License
See [LICENSE](LICENSE).