README.en.md

FixIt Bundle

👉 English README | 简体中文说明

🌲 Bundles the FixIt core theme and all hugo-fixit components into a single component.

Install Component

First make sure that your project itself is a Hugo module.

Then add this theme component to your hugo.toml configuration file:

[module]
  [[module.imports]]
    path = "github.com/hugo-fixit/fixit-bundle"

On the first start of Hugo it will download the required files.

To update to the latest version of the module run:

hugo mod get -u
hugo mod tidy

Usage

Add the following to your hugo.toml:

[params]
  # ...

[outputs]
  _merge = "shallow"

[taxonomies]
  _merge = "shallow"

[markup]
  _merge = "shallow"

[module]
  [[module.imports]]
    path = "github.com/hugo-fixit/fixit-bundle"

You can use all configurations and features of all included theme components.

Component List

• cmpt-flyfish
  🐟 一个 canvas 实现的小鱼游动动画效果。
• cmpt-mdevtools
  Mobile devtools component powered by vConsole and eruda.
• cmpt-translate
  🌐 A component for site automatic translation.
• component-projects
  🐙 Display your GitHub projects in the FixIt theme and generate blog posts from readme.
• hugo-atom-feed
  Hugo theme component for ATOM feed custom Output Format.
• hugo-json-feed
  Hugo theme component for JSON feed custom Output Format.
• shortcode-asciinema
  A Hugo theme component with asciinema-embed shortcode.
• shortcode-caniuse
  一个含有 caniuse shortcode 的 Hugo 主题组件。
• shortcode-docs-bookmark
  🔖 Embed bookmark of FixIt Docs.
• shortcode-mmt-netease
  🎶 A Hugo theme component with a NetEase Cloud random comment shortcode.
• shortcode-rewards
  A Hugo theme component with reward-log or sponsor-log shortcode.