Automattic / Automattic/harper

MDbook Includes trigger alot of false positives

Open
#2,631 0 comments 1 reaction 0 assignees View on GitHub
bug harper-core linting
Dominant language
Rust
Stars
15.4k
Forks
627
Avg merge
1d 15h
Merged PRs (30d)
102

Description

**What got flagged?**
```md
{{#include ../../partials/stages.md:pre}}
```

**Why is this incorrect?**
Mdbook allows including files and partials.

This allows not repeating some information in docs, and increases maintainability.
those includes shouldn't be flagged at all, or there should be a flag to ignore anything inside `{{ }}`

Contributor guide

Open the contributing guide

Research direction

Reproduce the false positive with the shown mdBook include snippet, then read the linked mdBook inclusion documentation and trace how Markdown template syntax is analyzed. Done means the include is no longer incorrectly flagged, or an explicitly supported way to ignore content inside `{{ }}` is documented and tested.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, rust
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.