Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 

Repository files navigation

Markdown Linter for Spec Kit

A Spec Kit extension that validates markdown files in specification documents for formatting consistency, broken links, and style guide compliance.

Installation

specify extension add markdown-linter --from https://github.com/Devdeep781/spec-kit-test-extension/archive/refs/tags/v1.0.0.zip

Commands

speckit.markdown-linter.lint

Scans all .md files in the current spec project and reports formatting issues.

speckit markdown-linter lint --fix

speckit.markdown-linter.check-links

Validates all hyperlinks in markdown documents are reachable.

speckit markdown-linter check-links --timeout 30

Configuration

Add to your speckit.yml:

extensions:
  markdown-linter:
    rules:
      max-line-length: 120
      no-trailing-spaces: true
      heading-style: atx
    exclude:
      - "vendor/**"
      - "node_modules/**"

Supported Rules

Rule Description Auto-fix
max-line-length Enforce maximum line length Yes
no-trailing-spaces Remove trailing whitespace Yes
heading-style Consistent heading format Yes
no-duplicate-headings Unique heading text No
link-format Consistent link formatting Yes

Development

git clone https://github.com/Devdeep781/spec-kit-test-extension
cd spec-kit-test-extension
python3 -m pytest tests/

Architecture Notes

The extension uses a modular rule engine where each rule is a standalone Python class implementing the BaseRule interface. Rules are discovered automatically via entry points.

License

MIT — see LICENSE for details.

Contributing

Issues and PRs welcome. Please run python3 -m pytest before submitting.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors