Skip to content

Commit 70945f3

Browse files
yfgeclaudepre-commit-ci[bot]
authored
feat: add markdownlint integration for consistent documentation quality (#10)
* feat: add editorconfig focused on Python backend development (#8) - Add Python configuration with 4-space indentation and 200-char line length - Configure YAML/JSON files with 2-space indentation - Add Markdown configuration with UTF-8 encoding, preserve trailing whitespace - Add TOML configuration for config files - Remove JavaScript/TypeScript frontend configurations to focus on backend needs - Ensure consistent formatting across all project file types 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Claude <[email protected]> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: Claude <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 2505524 commit 70945f3

File tree

3 files changed

+126
-1
lines changed

3 files changed

+126
-1
lines changed

.markdownlint.yaml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Markdownlint configuration for markdown-flow-agent-py
2+
# See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
3+
4+
# Default state for all rules
5+
default: true
6+
7+
# Line length - disabled as it can affect readability
8+
MD013: false
9+
10+
# Heading style
11+
MD003:
12+
style: "atx"
13+
14+
# Unordered list style
15+
MD004:
16+
style: "dash"
17+
18+
# Ordered list item prefix
19+
MD029:
20+
style: "ordered"
21+
22+
# Code block style
23+
MD046:
24+
style: "fenced"
25+
26+
# Emphasis style
27+
MD049:
28+
style: "underscore"
29+
30+
# Strong style
31+
MD050:
32+
style: "asterisk"
33+
34+
# Allow inline HTML (needed for some advanced formatting)
35+
MD033: false
36+
37+
# Allow bare URLs (common in documentation)
38+
MD034: false
39+
40+
# First line in file should be a top level heading (not always needed)
41+
MD041: false
42+
43+
# No duplicate headings (allow with different nesting)
44+
MD024:
45+
siblings_only: true
46+
allow_different_nesting: true
47+
48+
# No trailing punctuation in headings
49+
# Allow question marks for FAQ-style headings
50+
MD026:
51+
punctuation: ".,;:!"
52+
53+
# Allow multiple top-level headings (for documentation)
54+
MD025: false
55+
56+
# Allow emphasis as heading (disable MD036 for flexibility)
57+
MD036: false
58+
59+
# Ignore files
60+
exclude:
61+
- "node_modules/**"
62+
- ".git/**"
63+
- ".mypy_cache/**"
64+
- ".ruff_cache/**"
65+
- "*.egg-info/**"
66+
- "build/**"
67+
- "dist/**"

.pre-commit-config.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,16 @@ repos:
4747
description: Ensures test files are named correctly
4848
args: [--pytest-test-first]
4949

50+
# =============================================================================
51+
# Markdown linting
52+
# =============================================================================
53+
- repo: https://github.com/igorshubovych/markdownlint-cli
54+
rev: v0.45.0
55+
hooks:
56+
- id: markdownlint
57+
description: Lint and format markdown files
58+
args: ["--fix"]
59+
5060
# =============================================================================
5161
# Python code formatting and linting (Ruff - modern replacement for Black/Flake8/isort)
5262
# =============================================================================

0 commit comments

Comments
 (0)