Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not index HTML comments in Markdown documents #416

Merged
merged 1 commit into from
Feb 21, 2024

Conversation

solimant
Copy link
Contributor

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@solimant solimant changed the title Do not index html comments Do not index HTML comments in Markdown documents Feb 21, 2024
@solimant solimant merged commit 38d596e into main Feb 21, 2024
2 checks passed
@solimant solimant deleted the dont_index_HTML_comments branch February 21, 2024 12:38
@solimant solimant mentioned this pull request Feb 21, 2024
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant