Get Involved

Nov 27, 2021 1 min read Docs

Since `v0.68.0`, HBS uses Hugo Pipes to generate CSS and JS assets, there are a lot of breaking changes, please check out the CHANGELOG and UPGRADE for details.

Before using this theme, please make sure that you meet the prerequisites.

This theme provides several kinds of layouts, such as posts and docs. Our documentation uses the docs layout. If you're looking for an example that using posts layout, please take a look at the page Markdown Syntax.

We are happy to listen to your opinions and feedback, and welcome you to get involved.

Community

Feature Request
Bug Report
Discussions : ask questions, share ideas etc.

Contribute

Any contributions are welcome, such as docs, bug fix and new feature.

Rules

In view of ease of maintenance, we draw up some rules.

Conventional Commits Specification

Please follow the Conventional Commits Specification .

For example:

bug fix: fix: correct typos
new feature: feat: add the foobar parameter
docs: docs: document the foobar parameter
style: style: change the background color to blue
rebuild assets: chore: rebuild assets

Develop

The theme relies on npm and webpack for building assets: JS, CSS, fonts etc.

The source code were placed in src directory.

Install dependencies

1$ npm install

Rebuild assets

1$ npm run build

npm run watch will rebuild assets on change.

Preview

1$ npm run serve

Copyright

CC BY-NC-ND 4.0