# @dasiux/dashboard-generator

> Dashboard Generator, build a static html file with a tree of links.

Latest version **0.9.2** (published 2021-08-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @dasiux/dashboard-generator
pnpm add @dasiux/dashboard-generator
yarn add @dasiux/dashboard-generator
bun add @dasiux/dashboard-generator
```

Provides the command `dashg`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.9.2 |
| Published | 2021-08-15 |
| First published | 2021-08-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 56.6 KB |
| Known vulnerabilities | 0 (+4 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Daniel Hartwell |
| Maintainers | dasiux |
| Keywords | node, dashboard, generator, creator |

## Links

- npm: https://www.npmjs.com/package/@dasiux/dashboard-generator
- Repository: https://github.com/dasiux/dashboard-generator
- Homepage: https://github.com/dasiux/dashboard-generator#readme
- Issues: https://github.com/dasiux/dashboard-generator/issues
- npm.io page: https://npm.io/package/@dasiux/dashboard-generator

## Dependencies (7)

- [twig](https://npm.io/package/twig.md) ^1.15.4
- [deepmerge](https://npm.io/package/deepmerge.md) ^4.2.2
- [file-type](https://npm.io/package/file-type.md) ^16.5.3
- [node-sass](https://npm.io/package/node-sass.md) ^5.0.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1
- [html-minifier](https://npm.io/package/html-minifier.md) ^4.0.0
- [@squirrel-forge/node-cfx](https://npm.io/package/@squirrel-forge/node-cfx.md) ^1.0.2

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.9.2 (latest) — 2021-08-15
- 0.9.1 — 2021-08-14

## README

# dashboard-generator
Dashboard Generator, build a static html file with a tree of links.

## Install
```
npm i -g @dasiux/dashboard-generator
```

## How to use

Create a json file with following structure and fill the tree property with objects.
The first level must always contain an object and represents your base groups.
Properties are the labels and slugged for icon reference, values are the link.
To add sub groups use nested objects.

```json
{
  "title": "my Dashboard",
  "tree": {
    "group1": {
      "link1": "#url1"
    },
    "group2": {
      "link2": "#url2",
      "nested": {
        "link3": "#url3"
      }
    }
  }
}
```

To add spacers use a single # as the link value.
```json
{
  "link1": "#url1",
  "-1": "#"
}
```

Run the generator with following command:
```
dashg path/to/src.json
```

Options can be set as following:
```
Short# -o
Short# -o=value
Escaped # -o="value value"

Long # --option
Long # --option=value
Escaped # --option="value value"
```

## Settings

Short | Long      | Type | Description
----- | --------- | ---- | ---
  -o  | --output  | Path | Uses current cwd if not set
  -r  | --replace | Bool | Replace target
  -s  | --sass    | Path | Extend theme with your own sass code
  -d  | --dev     | Bool | Enable dev output

### Theme option examples
Option                | Values
--------------------- | ---
 --t-style            | none, simple, smooth, sharp
 --t-tree-nesting     | none, indent
 --t-background-style | none, gradient, gradient-animated, image
 
See the [defaults.json](template/defaults.json) and [_theme.scss](sass/global/_theme.scss) for all available values.
These options can also be set in your source json.

---
_Source: https://npm.io/package/@dasiux/dashboard-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._