/hugo-mod-chartist

hugo-chartist is a module for the static site generator hugo to implement chartist.js.

Primary LanguageJavaScriptOtherNOASSERTION

hugo-mod-chartist

hugo-mod-chartist is a module for the static site generator hugo to implement chartist.js.

Installation

  1. Add the module to your go.mod. E.g.
module github.com/<myself>/<myHugoInstance>

go 1.14

require github.com/chemiker/hugo-mod-chartist latest
  1. Add the module to the config.toml of your Hugo configuration:
[module]
  [[module.imports]]
    path="github.com/chemiker/hugo-mod-chartist"
    disabled = false
      [[module.imports.mounts]]
        source="dist/layouts/partials/"
        target="layouts/partials/"
      [[module.imports.mounts]]
        source="dist/assets/sass/"
        target="assets/sass/"
      [[module.imports.mounts]]
        source="dist/static/js/"
        target="static/js/"

  1. Update the modules of your Hugo configuration by running hugo mod get -u

  2. Implement the partial template head-chartist.html in your website's <head>.

Usage

You can use <script> tags to create chartist.js instances as described in the chartist.js documentation.

Development

It is highly welcome that you fork this repository, file issues or submit pull requests. The module uses yarn to fetch, modify and merge necessary resources. You can run yarn install to fetch all resources and yarn run gulp make to run the build scripts.

License

This project is released under the MIT license.

It contains software and fonts released under individual licenses:

  • chartist.js - Copyright (c) 2013 Gion Kunz is released under the MIT license (see file "licenses/LICENSE-CHARTIST")

  • chartist.js Axistitle plugin - Copyright (c) 2019 Alex Stanbury is released under the MIT license (see file "licenses/LICENSE-CHARTIST-PLUGIN-AXISTITLE")