Docs

Introduction

Get started with Hinode, a clean documentation and blog theme for your Hugo site based on Bootstrap 5.
Prerequisites   Installation   Next Steps  

Hinode is a clean documentation and blog theme for Hugo  - an open-source static site generator. Based on the Bootstrap  framework, the rendered site is fast, secure, and responsive. Hinode uses FlexSearch  to enable full text search across your site. Finally, the theme provides optional support for Node Package Manager  (npm) to automate the build process and to keep track of dependencies. More information is available on the About page.

Prerequisites  

 

Hinode v2.0.0  requires Dart Sass  to correctly transpile the various stylesheets. This is triggered by the upgrade to Font Awesome v7, which is no longer compatible with the old LibSass library. Several libraries, most notably Bootstrap  , are still being migrated to Dart Sass  . You can silence deprecation warnings adjacent to Hinode’s transpiler settings:

[params.main.build]
  transpiler = "dartsass"
  silenceDeprecations = true

Hinode is a Hugo theme that uses 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. Hinode requires the following software to be installed on your local machine:

Software Hugo npm Remarks
Go binary      Required for Hugo modules, including Hinode itself
Hugo (extended)    Embedded as npm binary
Dart Sass      Required since Hinode v2
Node.js    The installation package includes npm
Git  recommended   Recommended for version control

Installation  

The next steps describe how to initialize a new Hinode site using either Hugo or npm.

  Caution

In general, it is not recommended to fork the Hinode repository. Unlike the versioned releases, the repository HEAD is not guaranteed to be stable. Unless contributing to the development of Hinode, you are encouraged to use one of the installation options described below.

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

  1. Create a new site

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

  2. Initialize the module system

    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

    hugo server

  1. Create a new repository

    Go to https://github.com/gethinode/template.git  and login to GitHub as needed. Next, click the green button Use this template   to initialize a new repository based on the Hinode template.

    Alternatively, you can use the GitHub cli  to initialize the repository from the command line. Replace --private with --public if you wish to create a public repository instead.

    gh repo create my-hinode-site --private --template="https://github.com/gethinode/template.git"

  2. Configure a local site

    Assuming your repository is owner/my-hinode-site, use the git command to clone the repository to your local machine.

    git clone https://github.com/owner/my-hinode-site && cd my-hinode-site

    Now install the npm packages and hugo modules.

    npm install && npm run mod:update

  3. Start the development server

    npm run start

Next Steps  

Visit the tutorial to Create Your First Site With Hinode , or explore the Markdown Fundamentals to review the content formatting options.

On this page