Getting Started

Automd scans for the annotation comments within the markdown document and updates their contents using built-in generators.

The syntax is like this:

<!-- automd:generator [...args] -->
<!-- /automd -->

Using CLI

The easiest way to use automd is to use the CLI. You can install automd and add it to the build or release command in package.json or directly run npx automd in your project.

npx automd@latest

By default, the README.md file in the current working directory will be used as the target.

You can use --dir and --input arguments to customize the default behavior to operate on any other markdown file.