Get started with Hinode, a clean documentation and blog theme for your Hugo site based on Bootstrap 5.
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.
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:
|Go binary||Required for Hugo modules, including Hinode itself|
|Hugo (extended)||Embedded as npm binary|
|Node.js||The installation package includes npm|
|Git||recommended||Recommended for version control|
|Dart Sass||optional||optional||Required when using Dart Sass transpiler|
The next steps describe the approach how to initialize a new Hinode site using either Hugo or npm.
Create a new site
hugo new site my-hinode-site && cd my-hinode-site
Initialize the module system
hugo mod init example.com/my-hinode-site echo "[[module.imports]]\npath = 'github.com/gethinode/hinode'" >> hugo.toml
Start a development server
Create a new repository
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
to initialize the repository from the command line. Replace
--public if you wish to create a public repository instead.
gh repo create my-hinode-site --private --template="https://github.com/gethinode/template.git"
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
Start the development server
npm run start
main Hinode repository
contains a folder
exampleSite with sample content for a blog and a project portfolio. The examples are available in English, French, and Dutch. Review the following items on to how organize and enrich your content.
The main site configuration is available in
./config/_default. Review the following items to get you started.
/config/_default/params.toml. Review the colors documentation for more details.
config/_default/languages.toml. Set the default behavior in
config/_default/hugo.toml. Review the languages documentation for more details.
The next topics give an overview of the advanced configuration settings.
assets/scss/app.scss. See the styles documentation for more details.
Hinode uses rather strict security policies to ensure the site is secure by default. Be sure to include references to external sources in the header configuration to avoid broken links. The settings of the local development server are defined in
config/_default/server.toml. Similar settings are defined in the
netlify.toml file provided in the repository’s root when deploying to
. See the server documentation for more details.