idyll-lang/idyll

Katex in static output

Open

#655 opened on 2020年7月1日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)JavaScript (1,977 stars) (97 forks)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
Issue 種別
bug
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
Katex in static output · idyll-lang/idyll#655 | Good First Issue