How do I get preset remark-preset-lint-markdown-style-guide to ignore frontmatter?

[arrrgi]

My Markdown has YAML frontmatter. eg:

---
id: doc2
title: Document Number 2
---

This is a link to [another document.](doc3.md) This is a link to an [external page.](http://www.example.com/)

When linting with both the remark-frontmatter and remark-preset-lint-markdown-style-guide plugins I get a warning that fields in the frontmatter don't match the "header: atx" rule.

Am I doing something wrong or should I report this as a bug?

My basic Remark config looks like this:

exports.plugins = [
  'remark-frontmatter',
  'remark-external-links',
  'remark-capitalize',
  'remark-preset-lint-markdown-style-guide'
];

exports.settings = {
  strong: '*'
};

[wooorm]

That should indeed work. Can you make a reproduction for this?

[wooorm]

Ah, then it’s this one: https://github.com/remarkjs/remark-frontmatter#important.

mdx-js/mdx is still on an old remark unfortunately, so downgrading should do the trick

[JounQin]

I would recommend you to use prettier for formatting instead.

remark-preset-prettier may help.

[arrrgi]

Thanks @JounQin - Prettier is already inside my ecosystem. Linting is an additional requirement to keep syntax the same across MDX and MD in my use case

[JounQin]

remark-lint-heading-style may be conflicted with prettier, so just use remark-preset-prettier, there will be no related issue including the current one you're facing.

[arrrgi]

I see how this is useful as it will just ignore the header: atx rule requirement then

[JounQin]

remark-mdx@1 is not compatible with remark@13 yet, but remark-cli and remark-lint have been upgraded to remark@13.0.

What means when you're running eslint with eslint-mdx, remark@12 is used, but when you're running remark-cli, remark@13 is used.

@wooorm I'm also wondering can we support remark@13 for remark-mdx@1 at the same time, since remark-mdx@2 is not ready yet.

[wooorm]

remark@13 is a 100% different parser. That’s why it’s not possible to combine all these things, and it was major versions through the whole ecosystem!

[arrrgi]

Not quite back to square one but at least it's been identified what was happening, thanks both. Sounds like I should sit tight till the both remark-mdx and eslint-mdx capture the remark@13 changes.