Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gethinode/hinode

A clean documentation and blog theme for your Hugo site based on Bootstrap 5
https://github.com/gethinode/hinode

blog bootstrap documentation hugo-theme

Last synced: 1 day ago
JSON representation

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

Host: GitHub
URL: https://github.com/gethinode/hinode
Owner: gethinode
License: mit
Created: 2022-01-12T05:20:40.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-12-18T13:19:12.000Z (5 days ago)
Last Synced: 2024-12-18T14:28:07.673Z (5 days ago)
Topics: blog, bootstrap, documentation, hugo-theme
Language: HTML
Homepage: https://gethinode.com
Size: 37.7 MB
Stars: 154
Watchers: 4
Forks: 55
Open Issues: 23
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Hugo Theme Hinode



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

    






    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    

    

        

    





  About •

  Prerequisites •

  Installation •

  Configuration •

  Contributing •

  Donate •

  License



## About

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

- [Online Demo][demo]

- [PageSpeed Insights][pagespeed]

- [Mozilla Observatory][observatory]

Hinode is a clean documentation and blog theme for [Hugo][hugo], an open-source static site generator. Based on the [Bootstrap 5][bootstrap] framework, the rendered site is fast, secure, and responsive. Hinode uses [FlexSearch][flexsearch] to enable full text search across your site. Finally, the theme supports [Node Package Manager][npm] (npm) to automate the build process and to keep track of dependencies.

Detailed information about Hinode is available on the [official website][website].

## Prerequisites

Hinode is a [Hugo theme that uses modules][hugo_modules] to install and maintain various components. It can be installed using either Hugo or npm. If you would like to take advantage of automation, the npm approach is recommended. Refer to the [Hinode template][repository_template] for installation instructions with npm.

The installation instructions in this readme install Hinode as a regular Hugo theme. Hinode requires the following software to be installed on your local machine.

- [Go binary][golang_download]

- [Hugo][hugo_download] (extended version)

[Git][git_download] is recommended, but is not a strict requirement.

## Installation

Installation notes for Windows

The installation for Windows requires PowerShell v7. Download it from the Microsoft Store as needed. Check your current version with the command `$PSVersionTable`.

Start a new Hinode project in three steps:

1. **Create a new site**

    ```bash

    hugo new site my-hinode-site && cd my-hinode-site

    ```

2. **Initialize the module system**

    ```bash

    hugo mod init example.com/my-hinode-site

    echo "[[module.imports]]" >> hugo.toml

    echo "path = 'github.com/gethinode/hinode'" >> hugo.toml

    ```

3. **Start a development server**

    ```bash

    hugo server

    ```

## Configuration

See the [official documentation][getstarted] on how to configure your site.

## Contributing

See the [official documentation][contribute] on how to contribute to the open-source development of Hinode.

## Credits

Hinode is inspired by the following themes:

- [Blist][blist] - a clean and fast blog theme for your Hugo site using Tailwind CSS.

- [Doks][doks] - a Hugo theme for building secure, fast, and SEO-ready documentation websites, which you can easily update and customize.

## Donate



## License

The `hinode`, `docs`, and `template` codebase is released under the [MIT license][license]. The documentation of Hinode is licensed under the Creative Commons [(CC BY-NC 4.0)][cc-by-nc-4.0] license. This includes all files within the repository's `/content` and `/exampleSite/content` folders and their children, as well as the "README" in the repository root. This applies to all public repositories maintained by `gethinode` on GitHub, including the `gethinode/hinode`, `gethinode/template`, and `gethinode/docs` repositories, unless specified otherwise.

[blist]: https://github.com/apvarun/blist-hugo-theme

[bootstrap]: https://getbootstrap.com

[cc-by-nc-4.0]: https://creativecommons.org/licenses/by-nc/4.0/

[doks]: https://github.com/h-enk/doks

[flexsearch]: https://github.com/nextapps-de/flexsearch

[git_download]: https://git-scm.com

[hugo]: https://gohugo.io

[hugo_download]: https://gohugo.io/installation

[hugo_modules]: https://gohugo.io/hugo-modules/

[netlify]: https://www.netlify.com

[nodejs]: https://nodejs.org

[npm]: https://www.npmjs.com

[observatory]: https://observatory.mozilla.org/analyze/demo.gethinode.com

[pagespeed]: https://pagespeed.web.dev/report?url=https%3A%2F%2Fdemo.gethinode.com%2F

[contribute]: https://gethinode.com/contribute

[getstarted]: https://gethinode.com/docs

[golang_download]: https://go.dev/dl/

[demo]: https://demo.gethinode.com/

[license]: https://github.com/gethinode/hinode/blob/main/LICENSE

[repository]: https://github.com/gethinode/hinode.git

[repository_template]: https://github.com/gethinode/template.git

[website]: https://gethinode.com/