DavidAnson / markdownlint

A Node.js style checker and lint tool for Markdown/CommonMark files.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Use markdownlint wirth quarto ".qmd" - files

GitHubGeniusOverlord opened this issue · comments

Hi,

is there a way to use this plugin on .qmd files?
Quarto https://github.com/quarto-dev/quarto-cli is a scientific publishing system based on markdown which allows executing code in between the markdown elements.
It would be absolutely awesome if we could make markdownlint work with quarto.

Example:
test.qmd

# This is just some markdown
and we expect markdownlint to mark this as missing a line in between

As a library, you can pass any file in and it will be linted. If you are using this library through one of the markdownlint CLIs, you can similarly specify "*.qmd". If you are using the VS Code markdownlint extension, you can tell Code to treat .qmd files as Markdown and they should automatically be linted.

Worked for me with the VS Code extension. It would be cool to mention this in the extensions documentation. Or possibly to set this property at installation time.

I have to correct: While VS Code can be taught to teach .qmd files as .md, this leads to the .qmd loosing its properties. For examples a cell in the .qmd cannot be run anymore. This renders this approach unusable at the moment.

As a request for linting non-Markdown files in the VS Code extension, this is a duplicate of: DavidAnson/vscode-markdownlint#228