# markdown-validator

> Markdown creation standards

- Author: Frank Jung
- Repository: frankhjung/cli-gemini
- Version: 20260131152834
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-07
- Source: https://github.com/frankhjung/cli-gemini
- Web: https://mule.run/skillshub/@@frankhjung/cli-gemini~markdown-validator:20260131152834

---

---
name: markdown-validator
description: 'Markdown creation standards'
applyTo: '**/*.md'
---

# Markdown Validator

This skill specialises in validating markdown content to ensure it adheres to
established documentation and content creation standards.

## Markdown Content Rules

The following markdown content rules are enforced in the validators:

1. **Headings**: Use appropriate heading levels (H2, H3, etc.) to structure your
   content. Do not use an H1 heading, as this will be generated based on the
   title.
2. **Lists**: Use bullet points or numbered lists for lists. Ensure proper
   indentation and spacing.
3. **Code Blocks**: Use fenced code blocks for code snippets. Specify the
   language for syntax highlighting.
4. **Links**: Use proper markdown syntax for links. Ensure that links are valid
   and accessible.
5. **Images**: Use proper markdown syntax for images. Include alt text for
   accessibility.
6. **Tables**: Use markdown tables for tabular data. Ensure proper formatting
   and alignment.
7. **Line Length**: Limit line length to 400 characters for readability.
8. **Whitespace**: Use appropriate whitespace to separate sections and improve
   readability.
9. **Spelling and Grammar**: Ensure correct spelling and grammar throughout the
   content. Use Australian English for all text. Ensure US English is used for
   all included code.

## Formatting and Structure

Follow these guidelines for formatting and structuring your markdown content:

- **Headings**: Use `##` for H2 and `###` for H3. Ensure that headings are used
  in a hierarchical manner. Recommend restructuring if content includes H4, and
  more strongly recommend for H5.
- **Lists**: Use `-` for bullet points and `1.` for numbered lists. Indent
  nested lists with two spaces.
- **Code Blocks**: Use triple backticks
  (\`) to create fenced code blocks. Specify the language after the opening backticks for syntax highlighting (e.g., `csharp`).
- **Links**: Use `[link text](URL)` for links. Ensure that the link text is
  descriptive and the URL is valid.
- **Images**: Use `![alt text](image URL)` for images. Include a brief
  description of the image in the alt text.
- **Tables**: Use `|` to create tables. Ensure that columns are properly aligned
  and headers are included.
- **Line Length**: Break lines at 80 characters to improve readability. Use hard
  line breaks for long paragraphs.
- **Whitespace**: Use blank lines to separate sections and improve readability.
  Avoid excessive whitespace.

## Validation Requirements

Ensure compliance with the following validation requirements:

- **Content Rules**: Ensure that the content follows the markdown content rules
  specified above.
- **Formatting**: Ensure that the content is properly formatted and structured
  according to the guidelines.
- **Validation**: Run the validation tools to check for compliance with the
  rules and guidelines.
- **Feedback**: Provide feedback on any issues found during validation and
  suggest improvements.