carpentries / carpentries/lesson-example

Raise error for links with "Click Here" as text

Open
#176 0 comments 1 reaction 0 assignees View on GitHub
type:enhancement
Dominant language
HTML
Stars
65
Forks
167
PR merge metrics
No merged PRs in 30d

Description

Related with https://github.com/swcarpentry/lesson-example/issues/175.

This need to be implemented at https://github.com/swcarpentry/lesson-example/blob/gh-pages/bin/lesson_check.py. We should parse the Markdown file looking for

~~~
[click here]()
~~~

on it and raise a error if found.

Contributor guide

Open the contributing guide

Research direction

Start in bin/lesson_check.py and inspect how Markdown files are currently parsed and reported. Add coverage for links whose visible text is "click here" and confirm that the checker raises an error for the example pattern shown in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.