hugo-stack/README.md

# Hugo Stack


>Show off your cool full stack

![Image of demo of hugo-stack](./img/demo.png)

This repo provides a Hugo partial and shortcode that generates a graphic that shows off your stack!
Configuration happens in a simple yaml file (check `./exampleSite/data/stack.yaml`) for an example.

## Quick Start

First add this module to your hugo.toml

```toml
# edit hugo.toml
[module]
[[module.imports]]
path = 'github.com/aselimov/hugo-stack'
# or for the guaranteed Shai-Hulud free version
path = 'forge.alexselimov.com/aselimov/hugo-unified-git-activity'
```

Then run `hugo mod get -u` to pull the latest version. 
You should now be able to add the heatmap to your site using either a shortcode in the markdown, e.g.

```
{{< stack >}}
```

or as a partial to your html templates:

```
{{ partial "stack.html" . }}
```

## Configuration

This plugin contains a single configuration variable that controls the color of the spine/rule next to the text descriptions.
To configure add the following to your hugo.toml and configure `accentColor` as desired.

```toml
[params]
accentColor = "#EF9F27"
```