showdownjs/showdown

Expose blockTags in subParser 'hashHTMLBlock'

Open

#871 opened on Nov 8, 2021

View on GitHub
 (2 comments) (1 reaction) (1 assignee)JavaScript (13,700 stars) (1,640 forks)batch import
enhancementhelp wanted

Description

I am trying to force showdown to ignore my custom HTML tags for my text editor. The block tags is a list of tags that will be ignored during parsing, and adding my custom tag names to this list achieves the desired result: i.e. the text inside the tags are not parsed.

For now I achieved my desired result by adding a div tag around my custom tags like so:

type: 'lang',
regex: /<TagName(.*?)<\/TagName>/gs,
replace: '<div><TagName$1<\/TagName></div>'

Contributor guide

Tech stack
javascripthtml
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Showdown's subparsersFamiliarity with JavaScriptUnderstanding of HTML block tags
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests exposing blockTags in the hashHTMLBlock subparser. Currently, blockTags is a hardcoded list. The solution would involve making it configurable, likely by adding an option to the converter or the subparser. Look at how other options like 'simplifiedAutoLink' are implemented. The maintainer has not responded, so seek clarification on the desired API. Files to modify: src/subParsers/hashHTMLBlock.js and possibly src/showdown.js for option passing.
Expose blockTags in subParser 'hashHTMLBlock' · showdownjs/showdown#871 | Good First Issue