Skip to content

tobilg/dynamark

Repository files navigation

dynamark

Render dynamic markdown files using Handlebars templates.

Installation

To install the package globally, you can run

npm i -g dynamark

Usage

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 and data file, you can run the following:

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

This will produce the following output on stdout:

# test

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published