https://github.com/gethinode/customization-demo
Demo repository for the guide "Customizing the appearance of your site"
https://github.com/gethinode/customization-demo
Last synced: about 2 months ago
JSON representation
Demo repository for the guide "Customizing the appearance of your site"
- Host: GitHub
- URL: https://github.com/gethinode/customization-demo
- Owner: gethinode
- License: mit
- Created: 2024-08-18T06:35:33.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-01-16T20:07:01.000Z (4 months ago)
- Last Synced: 2025-01-22T16:11:16.166Z (3 months ago)
- Language: HTML
- Homepage:
- Size: 799 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Customization Demo
A demonstration of layout customization powered by Hinode
## About
Hinode is a clean blog theme for [Hugo][hugo], an open-source static site generator. Use this template if you would like to **take advantage of automation features**, provided by npm and GitHub actions. Visit the [docs][docs] for an alternative installation that uses Hugo only.
## Prerequisites
Hinode is a theme that uses [Hugo modules][hugo_modules] to install and maintain various components. The Hinode template requires the following software to be installed on your local machine. The Hugo binary itself is embedded as an npm binary.
- [Git][git_download]
- [Go binary][golang_download]
- [Node.js][nodejs] (it includes npm)
## Installation
1. **Create a new repository**
Click the button `Use this template` to initialize a new repository based on this template (log in to GitHub if needed).
2. **Clone a local copy**
```bash
git clone https://github.com/owner/my-hinode-site && cd my-hinode-site # replace "owner/my-hinode-site"
```
3. **Install the npm packages and hugo modules**
```bash
npm install && npm run mod:update
```
You can now run `npm run start` to start a local development server.
[docs]: https://gethinode.com/docs
[git_download]: https://git-scm.com
[golang_download]: https://go.dev/dl/
[hugo]: https://gohugo.io
[hugo_modules]: https://gohugo.io/hugo-modules/
[npm]: https://www.npmjs.com
[nodejs]: https://nodejs.org
[repository]: https://github.com/gethinode/hinode.git
[repository_template]: https://github.com/gethinode/template.git