Skip to content

Rolling out markdownlint-cli to lint Markdown #979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 25, 2025
Merged

Rolling out markdownlint-cli to lint Markdown #979

merged 2 commits into from
Jun 25, 2025

Conversation

jamesbraza
Copy link
Collaborator

Sister PR to Future-House/ldp#303

@jamesbraza jamesbraza self-assigned this Jun 24, 2025
@Copilot Copilot AI review requested due to automatic review settings June 24, 2025 17:40
@jamesbraza jamesbraza added the enhancement New feature or request label Jun 24, 2025
@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. documentation Improvements or additions to documentation labels Jun 24, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for linting Markdown files by configuring markdownlint-cli. It introduces a markdownlint configuration in pyproject.toml, updates the pre-commit hooks to include markdownlint, and adjusts the formatting in the README.md documentation.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
pyproject.toml Added markdownlint configuration settings
README.md Reformatted sections and adjusted text for clarity
.pre-commit-config.yaml Added a markdownlint hook to the pre-commit configuration

@jamesbraza jamesbraza merged commit 8903ba5 into main Jun 25, 2025
7 checks passed
@jamesbraza jamesbraza deleted the more-docs branch June 25, 2025 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants