Skip to content

Markdownlint should instead run after Liquid parsing #126

Open
@gonX

Description

@gonX

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingciAffects CI (Actions, bots, repo events, etc.)metaDotfiles, Scripts, Github files, Repository management

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions