Skip to content

Commit fcbf8e4

Browse files
authored
Merge pull request #437 from wunderio/feature/QAG-40-md
QAG-40: feat: Add markdown linting support
2 parents c35fe66 + b929c8e commit fcbf8e4

File tree

4 files changed

+10825
-3
lines changed

4 files changed

+10825
-3
lines changed

.markdownlint.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"default": true,
3+
"MD033": {
4+
"allowed_elements": ["details", "summary"]
5+
},
6+
"MD013": {
7+
"line_length": 300,
8+
"code_blocks": false,
9+
"tables": false,
10+
"headings": false
11+
},
12+
"MD032": false
13+
}

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,44 @@ For a complete list of all available services, URLs, and ports, use:
162162

163163
## Development tips
164164

165+
<details>
166+
<summary>Code quality tools</summary>
167+
168+
### Code quality tools
169+
170+
This project includes several tools to maintain code quality and consistency across the codebase.
171+
172+
#### Markdown Linting
173+
174+
Markdown files can be checked and automatically fixed using the following npm scripts:
175+
176+
```bash
177+
# Check markdown files for linting issues
178+
ddev npm run lint:md
179+
180+
# Automatically fix markdown linting issues where possible
181+
ddev npm run lint:md:fix
182+
```
183+
184+
Markdown linting rules are configured in `.markdownlint.json` at the project root.
185+
186+
#### JavaScript and CSS Linting
187+
188+
The project also includes linting for JavaScript and CSS files:
189+
190+
```bash
191+
# Check JavaScript files
192+
ddev npm run lint:js
193+
194+
# Check CSS/SCSS files
195+
ddev npm run lint:css
196+
197+
# Run all linting (JS, CSS, and Markdown)
198+
ddev npm run lint
199+
```
200+
201+
</details>
202+
165203
<details>
166204
<summary>Cursor AI Code Editor</summary>
167205

0 commit comments

Comments
 (0)