Commit 4c14dabfbd for woocommerce
commit 4c14dabfbd26165acaf53afe77561636eb62f99f
Author: Brian Coords <bacoords@gmail.com>
Date: Tue Jun 17 07:17:04 2025 -0700
Adds markdown lint testing to local docs build process (#58928)
* adds markdown lint to local docs build process
* fix lint:markdown command for better windows support
diff --git a/docs/_docu-tools/package.json b/docs/_docu-tools/package.json
index 26c7085ac8..4a94bfb9c0 100644
--- a/docs/_docu-tools/package.json
+++ b/docs/_docu-tools/package.json
@@ -5,7 +5,7 @@
"scripts": {
"docusaurus": "docusaurus",
"start": "docusaurus start",
- "build": "docusaurus build",
+ "build": "npm run lint:markdown && docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy",
"clear": "docusaurus clear",
@@ -13,6 +13,7 @@
"deploy-build": "docusaurus build --config ./utils/docusaurus.deploy.config.js",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
+ "lint:markdown": "markdownlint \"../**/*.md\" --ignore=\"../_docu-tools/\" --config=\"../../.markdownlint.json\"",
"typecheck": "tsc"
},
"dependencies": {
@@ -31,6 +32,7 @@
"@docusaurus/module-type-aliases": "3.7.0",
"@docusaurus/tsconfig": "3.7.0",
"@docusaurus/types": "3.7.0",
+ "markdownlint": "^0.38.0",
"typescript": "~5.6.2"
},
"browserslist": {
diff --git a/docs/contribution/contributing-docs/contributing-docs.md b/docs/contribution/contributing-docs/contributing-docs.md
index 6fb898164d..96c5c81aa9 100644
--- a/docs/contribution/contributing-docs/contributing-docs.md
+++ b/docs/contribution/contributing-docs/contributing-docs.md
@@ -24,7 +24,7 @@ This guide walks you through the structure, tooling, and process for contributin
2. For each modification you'd like to make, create a new branch off `trunk` in your fork that starts with `docs/`. For example, if you're adding a doc about improving extension performance, you could call your branch `docs/improve-extension-performance`.
3. Create or edit markdown files inside the appropriate folder under `docs/`.
4. If needed, update the folder's `_category_.json` (for sidebar label/position).
-5. Run a build to verify changes, confirm that the sitemaps and llms-txt files are updated, and detect broken links (link checking only happens on build):
+5. Run a build to verify changes, confirm that the sitemaps and llms-txt files are updated, and detect markdown linting errors and broken links (link checking only happens on build):
```bash
npm run build