# bpmnlint-generate-docs-images

**Repository Path**: mirrors_bpmn-io/bpmnlint-generate-docs-images

## Basic Information

- **Project Name**: bpmnlint-generate-docs-images
- **Description**: Generate documentation images for bpmnlint rules
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2025-11-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @bpmn-io/bpmnlint-generate-docs-images

[![CI](https://github.com/bpmn-io/bpmnlint-generate-docs-images/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/bpmnlint-generate-docs-images/actions/workflows/CI.yml)

Generate documentation images for your [bpmnlint](https://github.com/bpmn-io/bpmnlint) rules.

## Usage

Create or update images in your `docs/rules` based on example BPMN 2.0 files via this tool:

```sh
npx @bpmn-io/bpmnlint-generate-docs-images .
```

This assumes that your bpmnlint plug-in adheres to the [standard structure](https://github.com/bpmn-io/bpmnlint-plugin-example) for bpmnlint plug-ins.

## License

MIT