Skip to content

CHANGELOG.md

Latest commit

 

History

History
364 lines (258 loc) · 14.1 KB

CHANGELOG.md

File metadata and controls

364 lines (258 loc) · 14.1 KB
Raw

Changelog

All notable changes to the Markdown Linter Fixer skill will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.5.6] - 2026-02-09

Changed in 1.5.6

  • Improved skill metadata and structure in skills/markdown-linter-fixer/SKILL.md:
    • Updated YAML description with explicit trigger phrases for better skill discoverability
    • Added a top-level table of contents for faster navigation
    • Added a quick reference checklist for faster execution
    • Consolidated redundant scenario walkthroughs into a compact request-to-workflow mapping table
    • Tightened key principles into concise, policy-preserving guidance

[1.5.5] - 2026-02-09

Added in 1.5.5

  • Codex CLI skill support:
    • Added skills/markdown-linter-fixer/agents/openai.yaml for Codex UI metadata
    • Added scripts/install-codex-skill.sh to install the skill into ${CODEX_HOME:-~/.codex}/skills
    • Added scripts/uninstall-codex-skill.sh to remove the skill from Codex
  • Codex installation/uninstallation documentation in INSTALLATION.md

Changed in 1.5.5

  • Updated README.md to include Codex platform support, Codex prerequisites, and explicit $markdown-linter-fixer usage example
  • Reduced duplication (DRY): README.md now points to canonical Codex install/uninstall instructions in INSTALLATION.md

Fixed in 1.5.5

  • Resolved markdownlint issues discovered during full-repo linting:
    • MD024 duplicate headings in INSTALLATION.md
    • MD060 table column style in skills/markdown-linter-fixer/references/MD029-Fix-Guide.md

[1.5.4] - 2025-10-26

Changed in 1.5.4

  • Updated slash command format from /mdlinter to /markdown-linter-fixer:mdlinter throughout all documentation
    • Reflects the actual plugin-prefixed format used in Claude Code
    • Updated in README.md, PLUGIN.md, CONTRIBUTING.md, and commands/mdlinter.md
    • All 7 usage examples now show correct format
    • Historical CHANGELOG entries preserved with original /mdlinter format for accuracy

Improved in 1.5.4

  • Better alignment with Claude Code's plugin system conventions
  • Clearer documentation for users on how to invoke the slash command
  • More accurate representation of the actual command format

[1.5.3] - 2025-10-26

Added in 1.5.3

  • Link to chat mode definition file before VS Code installation buttons in README.md
    • Users can now review the chat mode instructions before installation
    • Ensures transparency and allows users to verify the chat mode is safe to use
    • Follows the same pattern as GitHub's awesome-copilot repository

Improved in 1.5.3

  • Enhanced installation section with better transparency for VS Code users
  • Added "markdown-linter-fixer mode instructions" link pointing to .github/chatmodes/markdown-linter-fixer.chatmode.md

[1.5.2] - 2025-10-26

Fixed in 1.5.2

  • Fixed VS Code markdown validator errors in chatmode file:
    • Removed backtick syntax that triggered tool reference detection (line 222)
    • Converted external GitHub URLs from markdown links to plain text with angle brackets to avoid file path validation errors (lines 323-325)
  • Removed Claude Code-specific "Command Shortcuts" section from VS Code chatmode file

Improved in 1.5.2

  • Better VS Code markdown validator compatibility for chatmode installation
  • Cleaner chatmode file without platform-specific command documentation

Changed in 1.5.2

  • Centralized version management: Version number now maintained only in README.md, plugin.json, marketplace.json, and CHANGELOG.md
  • Removed version references from PLUGIN.md and INSTALLATION.md to simplify maintenance

[1.5.1] - 2025-10-26

Fixed

  • Fixed VS Code installation links to use proper badge + aka.ms redirect pattern
  • Installation buttons now display correctly and trigger VS Code chat mode installation when clicked
  • Links use URL-encoded vscode:chat-mode/install protocol through Microsoft's redirect service
  • Follows official GitHub Copilot awesome-copilot repository pattern

[1.5.0] - 2025-10-21

Added in 1.5.0

  • VS Code Custom Chat Mode support:
    • Added markdown-linter-fixer.chatmode.md for GitHub Copilot users
    • One-click installation buttons for VS Code and VS Code Insiders
    • Same 6-phase systematic workflow as Claude Code plugin
    • Natural language commands for markdown linting in VS Code
  • VS Code installation section in README.md with quick install badges

Enhanced in 1.5.0

  • README.md now supports both Claude Code and VS Code users
  • Quick Links section updated to include VS Code Chat Mode Guide
  • Multi-platform availability clearly documented in Overview

Platform Support

  • Claude Code: Plugin via marketplace (existing)
  • VS Code: Custom chat mode via GitHub Copilot (new)

[1.4.0] - 2025-10-19

Added in 1.4.0

  • Comprehensive CLI testing commands section in CONTRIBUTING.md with:
    • Marketplace management commands (add, list, update, remove)
    • Plugin management commands (install, uninstall, enable, disable)
    • Verification commands for checking installation status
    • Complete testing workflow documentation
    • Iterative development workflow guidance
  • Testing local changes section in INSTALLATION.md
  • Slash command documentation in README.md and PLUGIN.md with:
    • Command format and argument descriptions
    • Usage examples for check and fix modes
    • Scope-based targeting (files, folders, patterns)
  • /mdlinter slash command in ./commands/mdlinter.md
    • Users automatically get the command when installing the plugin
    • Supports both check (scan only, by default) and fix (scan and repair) modes
    • Optional scope parameter for targeting specific files or folders
    • Safety-first design: Mode is optional and defaults to check when not specified or invalid
    • Examples: /mdlinter (check all), /mdlinter README.md (check specific file)

Fixed in 1.4.0

  • Marketplace manifest validation warning:
    • Restructured marketplace.json to use metadata.description instead of root-level description
    • Plugin now validates cleanly with claude plugin validate

Enhanced in 1.4.0

  • Uninstallation documentation with:
    • Complete step-by-step uninstall process
    • Known bug workaround for settings.json cleanup (issue #9537)
    • Manual cleanup instructions for all affected configuration files
    • Temporary disable alternative
  • Installation sections streamlined in README.md and PLUGIN.md for better clarity
  • Cross-references added between documentation files
  • .gitignore updated to exclude .claude/ directory (local development settings)

Improved in 1.4.0

  • Better developer experience with detailed CLI command reference
  • Clearer guidance for local development and testing iterations
  • More comprehensive troubleshooting with uninstallation workarounds
  • Enhanced documentation structure with better navigation

[1.3.3] - 2025-10-18

Changed in 1.3.3

  • Enhanced configuration policy with precise guidelines:
    • Do not ignore/hide linting errors by modifying .markdownlint-cli2.jsonc
    • Only modify ignores array based on explicit user input or .gitignore content
    • Never suppress errors without user consent - fix them instead
  • Updated SKILL.md with comprehensive configuration policy section
  • Added "md" tag to marketplace.json for better discoverability

Improved in 1.3.3

  • Updated MD029-Fix-Guide.md with simpler, more general examples (git/npm workflow instead of ansible-specific commands)
  • Real-world example now shows common installation steps that are more relatable for general users

[1.3.2] - 2025-10-18

Changed in 1.3.2

  • Updated SKILL.md to require explicit user approval before modifying ignores array in .markdownlint-cli2.jsonc
  • Added important note about not modifying file ignore list without user consent

[1.3.1] - 2025-10-18

Fixed in 1.3.1

  • Plugin manifest configuration to include skills array in marketplace.json
  • Skills array format in plugin.json (changed from object array to string array)
  • Plugin visibility issue - skill now properly appears in Claude Code available skills list
  • Added strict: false flag to marketplace.json plugin configuration

Changed in 1.3.1

  • Updated marketplace.json to follow Anthropic plugin structure with explicit skills paths
  • Simplified plugin.json skills format to use string array instead of object array

[1.3.0] - 2025-10-18

Added in 1.3.0

  • MD036-Guide.md reference documentation for proper heading usage
  • .markdownlint-cli2.jsonc configuration file support with ignores array
  • Configuration to exclude example files from linting
  • Memory note for markdown style guidelines

Changed in 1.3.0

  • Updated SKILL.md to recommend .markdownlint-cli2.jsonc instead of .markdownlint.json
  • Converted bold text subsections to proper markdown headings (####) throughout SKILL.md
  • Fixed heading hierarchy in SKILL.md (h2 → h3 → h4)
  • Enhanced configuration documentation with ignores array usage examples

Fixed in 1.3.0

  • All MD036 (no-emphasis-as-heading) errors in SKILL.md
  • All MD001 (heading-increment) errors in SKILL.md
  • Markdown linting errors in MD036-Guide.md reference file
  • Corrected .claude-plugin/marketplace.json source path format

Improved in 1.3.0

  • Better configuration file structure with support for file exclusions
  • Comprehensive documentation for avoiding MD036 violations
  • All markdown files now pass linting with 0 errors

[1.2.0] - 2025-10-18

Added

  • Claude Code plugin structure with marketplace support
  • .claude-plugin/marketplace.json for plugin catalog configuration
  • PLUGIN.md with comprehensive plugin documentation
  • Marketplace installation instructions in README.md
  • Skills reference in plugin.json manifest
  • Support for /plugin marketplace add installation method
  • Interactive plugin menu installation support
  • Team workflow configuration documentation
  • Local development installation guide

Changed

  • Reorganized project as Claude Code plugin with marketplace
  • Updated README.md installation section to prioritize marketplace installation
  • Renamed manual installation from Option 2 to Option 3
  • Enhanced plugin structure diagram to include marketplace.json
  • Updated plugin.json to include skills array reference

Improved

  • Easier installation via Claude Code plugin system
  • Better team collaboration through repository-level plugin configuration
  • More discoverable through marketplace browsing
  • Clearer separation between plugin documentation (PLUGIN.md) and skill documentation (README.md)

[1.1.0] - 2025-10-17

Added in version 1.1.0

  • Comprehensive MD029-Fix-Guide.md focusing on indentation as root cause
  • Real-world examples showing proper 4-space indentation
  • Table of indentation requirements for different content types
  • ❌ Wrong vs ✅ Correct example comparisons
  • Documentation on using markdownlint-disable comments
  • Detailed troubleshooting section

Changed in version 1.1.0

  • Updated SKILL.md to emphasize indentation focus for MD029 errors
  • Enhanced Phase 3 (Issue Analysis) to note MD029 patterns with code blocks
  • Improved Phase 5 (Manual Fixes) with clearer indentation guidance
  • Updated Resources section to accurately describe guide contents
  • Refined Scenario 3 to mention "lists with code blocks"

Improved in version 1.1.0

  • More practical focus on real-world MD029 causes
  • Better alignment with actual markdown linting issues developers face
  • Clearer explanations of when content breaks list continuity

[1.0.0] - 2025-10-17

Added in version 1.0.0

  • Initial release of Markdown Linter Fixer skill
  • 6-phase workflow for systematic markdown linting
  • Environment setup and prerequisites checking
  • Diagnostic assessment (root and recursive scans)
  • Issue analysis and categorization
  • Automatic fixes using markdownlint-cli2 --fix
  • Manual fix guidance
  • Verification and comprehensive reporting
  • MD029 reference guide (initial version)
  • Configuration file creation (.markdownlint.json)
  • Support for GitBash, WSL2, Linux, macOS

Features

  • Progressive disclosure design (3 levels)
  • Automatic markdownlint-cli2 detection
  • Sensible configuration defaults (MD013 disabled)
  • Clear error reporting at each phase
  • Configuration-aware (respects existing configs)
  • Common scenario examples
  • Integration with Anthropic Skills framework

Version History Summary

  • 1.4.0 - Documentation enhancements: CLI testing commands, slash command docs, uninstallation workarounds
  • 1.3.3 - Precise configuration policy: never hide errors, only use .gitignore or user-approved ignores
  • 1.3.2 - Enhanced configuration management with user approval requirement for ignores array
  • 1.3.1 - Fixed plugin manifest configuration for proper skill visibility
  • 1.3.0 - Configuration improvements and MD036 documentation
  • 1.2.0 - Plugin structure with marketplace support
  • 1.1.0 - Enhanced MD029 guide with indentation focus
  • 1.0.0 - Initial release with full workflow and basic MD029 guide

Upcoming Features

Potential future enhancements:

  • Support for additional markdownlint rules documentation
  • Interactive fix mode with user confirmations
  • Batch processing for multiple projects
  • Integration with CI/CD pipelines
  • Custom rule configuration templates
  • Git integration for commit hooks

Migration Notes

Upgrading to 1.2.0 (Plugin Structure)

If you previously installed as a standalone skill:

  1. Uninstall the old skill from Claude.ai/Desktop

  2. Install via Claude Code plugin system:

    /plugin marketplace add https://github.com/s2005/markdown-linter-fixer-skill
/plugin install markdown-linter-fixer@markdown-linter-fixer-marketplace

  3. All existing workflows continue to work

  4. Enjoy easier installation and updates

Upgrading from 1.0.0 to 1.1.0

No breaking changes. Simply replace the old skill package with the new one:

  1. Remove old skill from Claude
  2. Upload new markdown-linter-fixer.zip
  3. All existing workflows continue to work
  4. Enhanced MD029 guidance available immediately

For detailed information about each release, see the Releases page.