# dynamark

> A CLI to render Handlebars markdown templates with JSON or YAML data content

Latest version **0.1.1** (published 2023-06-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install dynamark
pnpm add dynamark
yarn add dynamark
bun add dynamark
```

Provides the command `dynamark`.

## 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.1.1 |
| Published | 2023-06-01 |
| First published | 2023-06-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 15.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | TobiLG |
| Maintainers | tobilg |
| Keywords | markdown, template, rendering, cli, automation |

## Links

- npm: https://www.npmjs.com/package/dynamark
- Repository: https://github.com/tobilg/dynamark
- Homepage: https://github.com/tobilg/dynamark#readme
- Issues: https://github.com/tobilg/dynamark/issues
- npm.io page: https://npm.io/package/dynamark

## Dependencies (4)

- [yaml](https://npm.io/package/yaml.md) ^2.3.1
- [commander](https://npm.io/package/commander.md) ^10.0.1
- [handlebars](https://npm.io/package/handlebars.md) ^4.7.7
- [markdownlint](https://npm.io/package/markdownlint.md) ^0.28.2

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2023-06-01
- 0.1.0 — 2023-06-01

## README

# dynamark
Render dynamic markdown files using [Handlebars](https://handlebarsjs.com/) templates.

## Installation
To install the package globally, you can run 

```bash
npm i -g dynamark
```

## Usage

```text
Usage: dynamark [options]

CLI to render markdown templates with data content

Options:
  -V, --version                  output the version number
  -t, --template <templatePath>  markdown template file path
  -d, --data <dataPath>          data file path (JSON or YAML)
  -o, --output <outputPath>      output file path (resulting markdown file)
  -l, --lint                     run markdownlint on the result
  -h, --help                     display help for command
```

### Example
If you want to render the [example template](examples/table.template.md) and [data file](examples/table.data.yaml), you can run the following:

```bash
dynamark -t examples/table.template.md -d examples/table.data.yaml --lint
```

This will produce the following output on `stdout`:

```markdown
# test

| Column1     | Column2     |
|-------------|-------------|
| test1 | test1 |
| test2 | test2 |
| test3 | test3 |
```

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