markdown-conventions

Markdown formatting and linting consistency is enforced by applying style rules for wrapping, code blocks, and callouts, then running automated checks to catch violations. This eliminates inconsistencies and improves documentation readability.

Checking Markdown for inclusivity issues is handled by integrating tools like alex and woke to scan content. These tools identify inconsiderate or biased language during the linting process, ensuring documentation remains welcoming and inclusive.

Automatically formatting Markdown files with mdformat requires running the tool against your target files. The tool applies defined conventions for wrapping and structural elements, instantly standardizing your documentation without manual edits.

Yes, the Markdown style guide supports GitHub Flavored Markdown and frontmatter through the mdformat-gfm and mdformat-frontmatter dependencies. This ensures proper formatting and linting for advanced syntax and metadata blocks.

Specific language identifiers in Markdown code blocks are needed whenever you include code snippets to ensure proper syntax highlighting and formatting. The linting guidelines enforce this best practice to maintain clarity and consistency in documentation.

Markdownlint is limited to checking structural style and syntax rules, so it cannot detect inclusivity issues. To address this, the Skill complements markdownlint with alex and woke to comprehensively scan for inconsiderate language.