abhinav/stitchmd action

Stitches together multiple Markdown files using stitchmd.

View on GitHub

Trust Signals

Scorecard Score
Scorecard 4–6scored Jul 13, 2026
Maintenance Recency
Activelast commit Apr 20, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: abhinav/stitchmd-action@ae7594a69ac0b21b6df6fd4358cb448bdd14c246 # v2.0.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
modeExecution 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.nocheck
versionVersion of stitchmd to use. Defaults to the latest version.nolatest
github-tokenAccess token used to make requests to the GitHub API.no${{ github.server_url == 'https://github.com' && github.token || '' }}
summaryPath to the input summary file. This defines the layout of the resulting Markdown file. Required if mode is not 'install'.no
outputPath to the output Markdown file. Required if mode is not 'install'.no
prefacePath to a preface file. The contents of this file will be included verbatim at the top of the output file.no
offsetOffset for heading levels. Defaults to zero.no0
no-tocDon't generate a table-of-contents under each section. Defaults to false.nofalse
check-can-failIn check mode, allow output to be out-of-sync and don't fail the job.nofalse
namedescription
install-pathPath at which stitchmd was installed.
check-failedWhether the check operation failed. This output is undefined in other modes.