hackmdio/codimd

Download as HTML and raw HTML doesn't display Math correctly anymore

Open

#944 opened on Sep 7, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (8,949 stars) (1,038 forks)batch import
Hacktoberfestbughelp wanted

Description

The following document contains some math which is nicely displayed in the editor but when downloading as html the math becomes ugly and some things completely fail.

https://hackmd-ce.herokuapp.com/dRNM0WorQHuJCoFgm76iOQ

This is a regression that occurred both on hackmd.io and in codimd. Back in March when I wrote that document on hackmd.io the downloaded html displayed fine. Yet the exact same html that I downloaded in March doesn't render properly anymore now.

Edit: When I copy the head from the HTML of the online editor the math displays correctly again. So I guess it would be just a matter of updating the head used for the "Download HTML" function.

@jackycute You are working on hackmd.io, right? Maybe you could fix it there too? :P Btw, do you have a separate bug tracker for hackmd.io ?

Edit 2: https://github.com/hackmdio/codimd/issues/885 (inlining the resources) might have prevented the regression.

Contributor guide

Tech stack
javascriptnodejs
Domain
backend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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
understanding of HTML export mechanismfamiliarity with MathJax or KaTeX
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue describes a regression where math rendering fails in downloaded HTML. The user suspects the head of the HTML export is outdated. Investigate the export HTML function (likely in the lib/ or controllers/ directory) and compare the included script tags for math rendering (MathJax or KaTeX) with the current online editor's head. Also check the linked issue #885 about inlining resources which may have caused the regression. Update the download HTML head to match the editor's head, ensuring correct math display.