https://github.com/gethinode/template

A template to get you started with Hinode quickly
https://github.com/gethinode/template

blog bootstrap hugo hugo-theme

Last synced: 18 days ago
JSON representation

A template to get you started with Hinode quickly

• Host: GitHub
• URL: https://github.com/gethinode/template
• Owner: gethinode
• License: mit
• Created: 2022-04-11T04:24:15.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T03:07:39.000Z (21 days ago)
• Last Synced: 2024-10-29T23:30:40.646Z (20 days ago)
• Topics: blog, bootstrap, hugo, hugo-theme
• Language: JavaScript
• Homepage: https://template.gethinode.com
• Size: 5.1 MB
• Stars: 9
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hinode - Template



    A clean documentation and blog theme for your Hugo site based on Bootstrap 5

    






    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    



## About

![Logo](https://raw.githubusercontent.com/gethinode/hinode/main/static/img/logo.png)

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