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

Markdownlint should instead run after Liquid parsing #126

Open
gonX opened this issue Dec 7, 2023 · 0 comments
Open

Markdownlint should instead run after Liquid parsing #126

gonX opened this issue Dec 7, 2023 · 0 comments
Labels
bug Something isn't working ci Affects CI (Actions, bots, repo events, etc.) meta Dotfiles, Scripts, Github files, Repository management

Comments

@gonX
Copy link
Member

gonX commented Dec 7, 2023

A lot of the markdownlint functionality is hampered because of Liquid tags

  • MD037 (Spaces inside emphasis markers) is disabled because of it
    • Our usage of underscores in path names for {% link %}s makes this rule parse incorrectly
  • MD044 (Names should have correct capitalization)
    • Same issue as with MD037, it recognizes Liquid tags as explicit text.
  • Reference links that are pointing to Liquid tags are not checked for link validity
    • E.g. [My link] with [Mylink]: {% link _sections.Tablets.md %}

While some of these issues are less of an issue with our HTML linting in place, there are other issues that cannot easily be worked around.

The best solution is as the title proposes, to extract the Markdown documents after the Liquid tags have been parsed so that markdownlint can correctly parse the documents as it expects. This is likely achieved by outputting the formatted documents as part of the Jekyll build process.

@gonX gonX added bug Something isn't working ci Affects CI (Actions, bots, repo events, etc.) meta Dotfiles, Scripts, Github files, Repository management labels Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working ci Affects CI (Actions, bots, repo events, etc.) meta Dotfiles, Scripts, Github files, Repository management
Projects
None yet
Development

No branches or pull requests

1 participant