matcornic/hugo-theme-learn

Search highlighting makes text within Mermaid-rendered SVG diagrams disappear when matched

Open

#235 opened on Feb 7, 2019

View on GitHub
 (0 comments) (1 reaction) (0 assignees)HTML (1,575 stars) (1,427 forks)batch import
bughelp wanted

Description

See following link for problem description and fix: https://github.com/vjeantet/hugo-theme-docdock/issues/112

This problem also exists in this learn theme. Can the described fix be ported to this theme?

Contributor guide

Tech stack
htmlcssjavascript
Domain
frontenddocumentation
Issue type
bug
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of Hugo themesCSS and JavaScript basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue describes a problem where search highlighting causes text in Mermaid rendered SVG diagrams to disappear. The referenced fix in another theme (docdock) should be analyzed and ported to this theme. Key files to examine: the search functionality JavaScript and CSS files in the theme, likely in 'static/js' or 'layouts/partials'. The fix may involve excluding SVG elements from search highlighting or adjusting the highlighting logic. Check the theme's search implementation and compare with the docdock fix to adapt it.