OpenTabletDriver / OpenTabletDriver/opentabletdriver.github.io

Markdownlint should instead run after Liquid parsing

Open
#126 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug ci meta
Dominant language
HTML
Stars
36
Forks
10
Avg merge
12h 32m
Merged PRs (30d)
9

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the Jekyll build process and the current markdownlint invocation, since no specific files or tests are named. Check how formatted documents could be emitted after Liquid parsing, then verify that markdownlint handles the listed emphasis, capitalization, and Liquid link cases correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll
Domain
build-system, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.