showdownjs/showdown

Expose blockTags in subParser 'hashHTMLBlock'

Open

#871 opened on Nov 8, 2021

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

Repository metrics

Stars
 (13,700 stars)
PR merge metrics
 (Avg merge 15h 21m) (3 merged PRs in 30d)

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

Research direction
Examine the `hashHTMLBlock` subParser in showdown's source code to understand how `blockTags` is currently defined and used. Then propose a way to expose it, such as adding a configuration option or making the list accessible via a method. Review existing tests and documentation to ensure backward compatibility.
Tech stack
javascript
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60