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

Community#

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 Hugo Pipes for building assets: JS, CSS, fonts etc.

The source code were placed in assets directory.

Install dependencies#

1$ cd exampleSite
2$ npm install

Preview#

1$ npm run serve