Module: Yard::Lint::Validators::Documentation::MarkdownSyntax

Defined in:

lib/yard/lint/validators/documentation/markdown_syntax.rb,
lib/yard/lint/validators/documentation/markdown_syntax/config.rb,
lib/yard/lint/validators/documentation/markdown_syntax/parser.rb,
lib/yard/lint/validators/documentation/markdown_syntax/result.rb,
lib/yard/lint/validators/documentation/markdown_syntax/validator.rb,
lib/yard/lint/validators/documentation/markdown_syntax/messages_builder.rb

Overview

MarkdownSyntax validator

Validates markdown syntax in documentation comments. This validator checks for common markdown errors and formatting issues in YARD documentation strings. This validator is enabled by default.

## Configuration

To disable this validator:

Documentation/MarkdownSyntax:
  Enabled: false

Examples:

Bad - Invalid markdown syntax

# This is [broken markdown
# Another line with `unclosed code
def process
end

Good - Valid markdown syntax

# This is [valid markdown](https://example.com)
# Another line with `closed code`
def process
end

Defined Under Namespace

Classes: Config, MessagesBuilder, Parser, Result, Validator