abhinav/stitchmd action
Stitches together multiple Markdown files using stitchmd.
View on GitHubTrust Signals
- Scorecard Score
- Scorecard 4–6scored Jul 13, 2026
- Maintenance Recency
- Activelast commit Apr 20, 2026
- License
- MIT
Pinned Snippet
uses: abhinav/stitchmd-action@ae7594a69ac0b21b6df6fd4358cb448bdd14c246 # v2.0.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| mode | Execution mode for the action. Supported execution modes are: 'install', 'check', and 'write'. 'install' verifies the tool and exits. 'check' verifies that the output file is up to date. This is the default. 'write' updates the output file in the workspace if it's outdated. | no | check |
| version | Version of stitchmd to use. Defaults to the latest version. | no | latest |
| github-token | Access token used to make requests to the GitHub API. | no | ${{ github.server_url == 'https://github.com' && github.token || '' }} |
| summary | Path to the input summary file. This defines the layout of the resulting Markdown file. Required if mode is not 'install'. | no | — |
| output | Path to the output Markdown file. Required if mode is not 'install'. | no | — |
| preface | Path to a preface file. The contents of this file will be included verbatim at the top of the output file. | no | — |
| offset | Offset for heading levels. Defaults to zero. | no | 0 |
| no-toc | Don't generate a table-of-contents under each section. Defaults to false. | no | false |
| check-can-fail | In check mode, allow output to be out-of-sync and don't fail the job. | no | false |
Outputs
| name | description |
|---|---|
| install-path | Path at which stitchmd was installed. |
| check-failed | Whether the check operation failed. This output is undefined in other modes. |