Merge pull request #1803 from IgniteUI/mt/lint-md-fixes

lint md fixes

Author: HUSSAR-mtrela

.markdownlint-README.md

@@ -0,0 +1,128 @@
+# Markdown Linting Configuration
+
+## Overview
+This directory contains markdown linting configuration for the Ignite UI for Angular documentation.
+
+
+## TODO
+
+Add devDependencies:
+
+- "markdownlint-cli": "^0.45.0",
+- "cspell": "^9.2.2",
+
+## Rules Configuration
+
+The `.markdownlint.json` file configures markdown-lint with relaxed rules suitable for technical documentation:
+
+### Enabled Rules
+- **MD001**: Heading levels should only increment by one level at a time
+- **MD003**: Heading style (ATX style with #)
+- **MD004**: Unordered list style (dash)
+- **MD007**: Unordered list indentation (2 spaces)
+- **MD009**: Trailing spaces (allow 2 for line breaks)
+- **MD010**: Hard tabs
+- **MD012**: Multiple consecutive blank lines (max 2)
+- **MD014**: Dollar signs used before commands without showing output
+- **MD018**: No space after hash on atx style heading
+- **MD019**: Multiple spaces after hash on atx style heading
+- **MD022**: Headings should be surrounded by blank lines
+- **MD023**: Headings must start at the beginning of the line
+- **MD024**: Multiple headings with the same content (siblings only)
+- **MD025**: Multiple top-level headings in the same document
+- **MD026**: Trailing punctuation in heading
+- **MD027**: Multiple spaces after blockquote symbol
+- **MD028**: Blank line inside blockquote
+- **MD029**: Ordered list item prefix (ordered style)
+- **MD030**: Spaces after list markers
+- **MD031**: Fenced code blocks should be surrounded by blank lines
+- **MD032**: Lists should be surrounded by blank lines
+- **MD035**: Horizontal rule style (---)
+- **MD037**: Spaces inside emphasis markers
+- **MD038**: Spaces inside code span elements
+- **MD039**: Spaces inside link text
+- **MD042**: No empty links
+- **MD045**: Images should have alternate text (alt text)
+- **MD046**: Code block style (fenced)
+- **MD047**: Files should end with a single newline character
+- **MD048**: Code fence style (backtick)
+- **MD049**: Emphasis style (underscore)
+- **MD050**: Strong style (asterisk)
+
+### Disabled Rules
+- **MD013**: Line length (disabled for technical docs with long URLs/code)
+- **MD033**: Inline HTML (allowed for component demos)
+- **MD034**: Bare URLs (allowed as we use many reference links)
+- **MD036**: Emphasis used instead of heading (allowed for styling)
+- **MD040**: Fenced code blocks should have a language specified (would be noisy)
+- **MD041**: First line in a file should be a top-level heading (not always applicable)
+- **MD043**: Required heading structure (too restrictive)
+- **MD044**: Proper names should have the correct capitalization (would require extensive config)
+
+## Usage
+
+### Run linting on all component docs
+```bash
+npx markdownlint "en/components/**/*.md"
+```
+
+### Run linting on specific file
+```bash
+npx markdownlint en/components/grid/grid.md
+```
+
+### Fix auto-fixable issues
+```bash
+npx markdownlint --fix "en/components/**/*.md"
+```
+
+### Run with custom config
+```bash
+npx markdownlint --config .markdownlint.json "en/components/**/*.md"
+```
+
+## Common Issues and Fixes
+
+### MD001 - Heading increment
+**Issue**: Jumping from `##` to `####`
+**Fix**: Use `###` instead
+
+### MD009 - Trailing spaces
+**Issue**: Unnecessary trailing spaces at end of line
+**Fix**: Remove trailing spaces (except when intentional for line breaks)
+
+### MD022 - Headings surrounded by blank lines
+**Issue**: No blank line before/after heading
+**Fix**: Add blank lines around headings
+
+### MD031 - Code blocks surrounded by blank lines
+**Issue**: No blank line before/after code fence
+**Fix**: Add blank lines around code blocks
+
+### MD047 - File should end with newline
+**Issue**: No newline at end of file
+**Fix**: Add single newline at end of file
+
+## Integration with CI/CD
+
+Add to package.json scripts:
+```json
+{
+  "scripts": {
+    "lint:md": "markdownlint 'en/components/**/*.md'",
+    "lint:md:fix": "markdownlint --fix 'en/components/**/*.md'"
+  }
+}
+```
+
+## VS Code Integration
+
+Install the "markdownlint" extension by David Anson for real-time linting in VS Code:
+- Extension ID: `DavidAnson.vscode-markdownlint`
+- The `.markdownlint.json` file will be automatically detected
+
+## Related Tools
+
+- **cspell**: Spell checking (configured in `cspell.json`)
+- **prettier**: Code formatting (if configured)
+- **remark-lint**: Alternative markdown linter with different rule set

.markdownlint.json

@@ -0,0 +1,47 @@
+{
+  "default": true,
+  "MD001": true,
+  "MD003": { "style": "atx" },
+  "MD004": { "style": "dash" },
+  "MD007": { "indent": 2 },
+  "MD009": { "br_spaces": 2 },
+  "MD010": true,
+  "MD012": { "maximum": 4 },
+  "MD013": false,
+  "MD014": true,
+  "MD018": true,
+  "MD019": true,
+  "MD022": false,
+  "MD023": true,
+  "MD024": false,
+  "MD025": { "front_matter_title": "" },
+  "MD026": { "punctuation": ".,;:" },
+  "MD027": true,
+  "MD028": false,
+  "MD029": { "style": "ordered" },
+  "MD030": true,
+  "MD031": true,
+  "MD032": false,
+  "MD033": false,
+  "MD034": false,
+  "MD035": { "style": "---" },
+  "MD036": false,
+  "MD037": true,
+  "MD038": true,
+  "MD039": true,
+  "MD040": false,
+  "MD041": false,
+  "MD042": true,
+  "MD043": false,
+  "MD044": false,
+  "MD045": true,
+  "MD046": { "style": "fenced" },
+  "MD047": false,
+  "MD048": { "style": "backtick" },
+  "MD049": { "style": "underscore" },
+  "MD050": { "style": "asterisk" },
+  "MD051": false,
+  "MD055": false,
+  "MD058": true,
+  "MD059": false
+}