alshedivat/al-folio

MathJax equation previews

Open

#2,456 opened on May 28, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)HTML (15,603 stars) (12,991 forks)batch import
enhancementhelp wanted

Description

Have you checked that your feature request isn't already filed?

  • I read through FAQ and searched through the past issues, none of which addressed my feature request.
  • Yes, I have checked that this feature request isn't already filed.

Description & Motivation

I saw elsewhere that it's possible to configure so that hovering over an equation reference can display a preview of the actual equation (much like hovering over footnotes or references shows the linked object in place).

Discussion: https://gist.github.com/mauriciopoppe/ec311235997fab7b2993

Would it be possible to support this feature?

Pitch

This is a non-critical but nice-to-have feature that could make reading technical blog posts easier without having to jump back and forth for references.

Alternatives

No response

Additional context

No response

Contributor guide

Tech stack
javascripthtmlcss
Domain
frontend
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic JavaScriptMathJax basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue requests adding hover previews for equation references using MathJax. The referenced gist (https://gist.github.com/mauriciopoppe/ec311235997fab7b2993) provides a possible solution using MathJax's tooltip feature. The contributor should inspect the repository's existing MathJax setup, likely in ` includes/` or ` layouts/`, to integrate the hover functionality. Testing on a local Jekyll server is recommended.