idyll-lang/idyll

Katex in static output

Open

#655 创建于 2020年7月1日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)JavaScript (1,977 star) (97 fork)batch import
CLIGood First PRbughelp wanted

描述

The Katex CSS does not properly load in the static output of Idyll Equations leading to duplicated equations. It is linked via a URL that does not work under the file:// protocol.

To Reproduce

  1. idyll create
  2. accept defaults to produce a basic article
  3. replace index.idyll with a file containing only "[Equation]x = x + 1[/Equation]"
  4. run "idyll build"
  5. open with "firefox build/index.html"
  6. the equation displays twice

The equation displays twice because the Katex stylesheet appears to be included with a URL that does not work under the file:// protocol. Could the CSS be included in the stylesheet produced by "idyll build" instead?

    <link
      rel="stylesheet"
      href="//cdnjs.cloudflare.com/ajax/libs/KaTeX/0.9.0/katex.min.css"
    />

Expected behavior Equation appears once / css is loadable.

Desktop (please complete the following information):

  • OS: Arch Linux
  • Browser: Firefox
  • Version: 77.0.1

贡献者指南

技术栈
javascriptcss
领域
frontend
议题类型
bug
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
basic HTML/CSSunderstanding of static build process
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
The fix is to include the Katex CSS in the generated stylesheet instead of using a protocol relative URL. Examine the build process in Idyll, particularly in the builder module where the <link> tag is inserted. Ensure the CSS is either bundled locally or the URL is changed to absolute https. Also check for similar external resources that may break under file:// protocol.