influxdata / influxdata/docs-v2
GitHub format linter escapes `[]` to prevent interpreting as links
- Dominant language
- JavaScript
- Stars
- 82
- Forks
- 326
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 82
Description
> This shouldn't need escaping.
The GitHub format linter escapes them to prevent interpretation as duplicate links that don't have a defined target URL. To prevent the escaping in content files, I had to remove the linter altogether - couldn't configure the behavior.
_Originally posted by @jstirnaman in https://github.com/influxdata/docs-v2/pull/6506#discussion_r2487071352_
Contributor guide
No contributing guide indexed for this repository
Research direction
No file or test is named in the issue. Start by locating the GitHub format linter configuration and the rule that escapes square brackets in content files; determine whether that rule supports an exception or option. Done means the linter remains enabled, valid literal [] content is not escaped, and linting still passes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100