Skip to content
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

Integrate Markdown linting #27

Open
JanssenBrm opened this issue Oct 14, 2024 · 0 comments
Open

Integrate Markdown linting #27

JanssenBrm opened this issue Oct 14, 2024 · 0 comments
Assignees
Milestone

Comments

@JanssenBrm
Copy link
Contributor

To ensure a consistent writing quality, it would be nice to integrate the markdownlint-cli through the pre-commit configuration. This integration has been tested in #24, but it requires a full refactor of most files so it deserves its own ticket.

  - repo: https://github.com/igorshubovych/markdownlint-cli
    rev: v0.42.0
    hooks:
      - id: markdownlint
        types: [file]
        files: \.(md|qmd)$
        args: [ "--fix" ]

To configure the plugin, create a .markdownlint.yaml file and paste the following content.

default: true
line-length:
  line_length: 120
  code_blocks: false
  tables: false
@JanssenBrm JanssenBrm self-assigned this Oct 15, 2024
@JanssenBrm JanssenBrm added this to the MTR milestone Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant