dev-ugurkontel/docsmoke

Validate executable Markdown snippets in CI.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Apr 22, 2026
License
Apache 2.0

Pinned Snippet

workflow.ymlSHA-pinned
uses: dev-ugurkontel/docsmoke@c32642cff1012e985a640f499d861ed4abf7d5ed # v1.0.0

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

namedescriptionrequireddefault
pathsSpace-separated Markdown files or directories to scan.no""
python-versionPython version used to install and run docsmoke.no3.12
package-specOptional pip install spec, for example `docsmoke==<exact-version>`. When omitted, the action installs the checked-out action source so the action ref and tool version stay aligned.no""
configOptional path to docsmoke.toml or pyproject.toml.no""
outputOptional output file path. When set, `format` is also used.no""
formatOutput format used with `output`.nomarkdown
all-supportedExecute all supported fenced blocks, even when not explicitly marked.nofalse
fail-fastStop after the first failing snippet.nofalse
extra-argsOptional additional CLI arguments, one argument per line.no""

no outputs