mixmark-io/turndown

Keeping/removing metadata content elements (e.g. script, style, title)

Open

#210 opened on Dec 20, 2017

View on GitHub
 (2 comments) (1 reaction) (0 assignees)HTML (11,165 stars) (982 forks)batch import
help wanted

Description

<script>, <style>, and <title> elements are not visible on a rendered web page, however Turndown will output their contents, e.g.

turndownService.turndown('<script>alert("Hello world")</script>') // alert("Hello world")

Perhaps these could be removed by default? The behaviour could be overridden with turndownService.keep (to render the elements wrapped in their tag) or by adding a rule. Or perhaps we should keep the default behaviour and add options to keep/remove e.g. keepScript, removeScript, keepStyle, removeStyle, keepTitle, removeTitle?

Contributor guide

Tech stack
javascripthtmlcss
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.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic understanding of Turndown libraryFamiliarity with HTML elements
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue proposes to remove content from script, style, and title elements by default in Turndown. Review the existing default rules in the source code (likely in src/ or lib/). Examine how keep/remove/addRule methods work to allow overriding the new default. Consider implementing a global option (e.g., removeScript, removeStyle, removeTitle) with default true. Also check if there are any existing discussions or PRs that attempted this change. The implementation should ensure backward compatibility by allowing users to keep those elements if desired.