Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds markdown linting support and Prettier configuration.
- Introduces new npm scripts (
lint:mdandlint:md:fix) for markdown files - Adds
markdownlint-cli2andprettieras dependencies - Includes
.markdownlint.jsonand.markdownlint-cli2.jsoncconfigs for lint rules and ignore patterns
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| package.json | Added markdown lint scripts and Prettier dependency |
| .markdownlint.json | Enabled default rules and disabled MD013, MD033 |
| .markdownlint-cli2.jsonc | Configured CLI schema and ignore patterns for linting |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (1)
package.json:40
- [nitpick] Prettier is added as a dependency but there's no configuration file; consider adding a .prettierrc or documenting default formatting rules in the README to ensure consistent usage.
"prettier": "^3.6.2",
| "build-git-batch": "docker run --rm -w $(pwd) -v $(pwd):$(pwd) quay.io/thegeeklab/git-batch" | ||
| "build-git-batch": "docker run --rm -w $(pwd) -v $(pwd):$(pwd) quay.io/thegeeklab/git-batch", | ||
| "lint:md": "markdownlint-cli2 '**/*.{md,markdown}'", | ||
| "lint:md:fix": "markdownlint-cli2 --fix '**/*.{md,markdown}'" |
There was a problem hiding this comment.
[nitpick] Consider adding a top-level "lint" script in package.json that runs both markdown and code lint checks, e.g., "lint": "npm run lint:md && npm run typecheck", to streamline linting workflows.
Suggested change
| "lint:md:fix": "markdownlint-cli2 --fix '**/*.{md,markdown}'" | |
| "lint:md:fix": "markdownlint-cli2 --fix '**/*.{md,markdown}'", | |
| "lint": "npm run lint:md && npm run typecheck" |
AlexAndBear
force-pushed
the
add-linter
branch
2 times, most recently
from
2225a59 to
92bd844
Compare
# Conflicts: # docs/dev/web/embed-mode.md # docs/dev/web/extension-system/extension-types/action-extensions.md # docs/dev/web/extension-system/extension-types/app-menu-item-extensions.md # docs/dev/web/extension-system/extension-types/custom-component-extensions.md # docs/dev/web/extension-system/extension-types/folder-view-extensions.md # docs/dev/web/extension-system/extension-types/right-sidebar-panel-extensions.md # docs/dev/web/extension-system/extension-types/search-extensions.md # docs/dev/web/extension-system/viewer-editor-apps.md # docs/dev/web/testing/e2e-testing-standards.md # prettier.config.js
# Conflicts: # package.json # pnpm-lock.yaml
Member
Author
|
@JammingBen this is the first batch, disabled in the CI since we still got about 230 errors even after running the fix command |
JammingBen
approved these changes
Jul 14, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added
pnpm lint:mdandpnpm lint:md:fixscripts to ensure consistent markdown formatting across the Docusaurus project.When to use
pnpm lint:mdRun this before committing or in CI to check for markdown style violations.
It ensures all markdown files follow the defined linting rules (e.g., consistent headings, spacing, or list styles) without modifying any files.
When to use
pnpm lint:md:fixRun this to automatically fix markdown formatting issues.
It rewrites your markdown files to match the project's linting configuration, saving time and reducing manual edits.
These scripts support clean and consistent documentation by enforcing markdown best practices across the codebase.