adobe / parliament-client-template

A template for client projects of the developer documentation site
Apache License 2.0
7 stars 18 forks source link

Do not index HTML comments in Markdown documents #416

Closed solimant closed 6 months ago

solimant commented 6 months ago

This PR omits HTML comments in Markdown documents from being indexed for search.

Description

In certain circumstances, Markdown documents may contain HTML comments, such as:

<!-- Comment 1 -->
Some text between comments
<!-- Comment 2 -->
Some more text

Indexing those comments is undesirable since those comments don't end up in the final rendered document.

This PR omits such comments so that only the target content is included in the search index.

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist: