Document support for ` \(` and `\[` math delimiters

オープン 初心者向け
#12,263 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
latex, markdown
領域
documentation

調査の方向性

issue でリンクされている quarto.org の「Markdown basics」ドキュメントの「equations」セクションから始め、markdown+tex_math_single_backslash 拡張機能がどのように提示されているかを確認します。(...) と [...] の区切り文字および例を追加してドキュメントを更新します。ユーザーが拡張機能の設定を見つけ、inline とブロックでの使い方の違いを理解できれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation
What would you like to do?

Report an issue on quarto.org

Description

Originally suggested by @JamesSmith20, moved from https://github.com/quarto-dev/quarto-cli/issues/11761 :

2. Support for \( and \[ Math Delimiters

Currently, the Quarto documentation on equations does not mention support for LaTeX-style math delimiters \(...\) (inline) and \[...\] (block). It states that only $...$ and $$...$$ are supported for inline and block math. However, using Pandoc’s markdown+tex_math_single_backslash extension, Quarto can support these delimiters seamlessly across Word, HTML, and PDF formats.

Here is an example:

---
title: "Quarto Playground"
from: markdown+tex_math_single_backslash
format:
  docx
---

Inline math example: \( E = mc^2 \)

Inline math example: $E = mc^2$

Block math example:

\[ a^2 + b^2 = c^2 \]

$$
a^2 + b^2 = c^2
$$

This works well to render equations using the preferred LaTeX-style delimiters, which are consistent with LaTeX standards and widely used by large language models and other AI tools. Including this information in the official documentation would help users integrate equations more easily without manual adjustments.

Suggested Improvements:
  1. Document Support for \( and \[ Delimiters:
    • Update the math documentation to mention the use of markdown+tex_math_single_backslash for LaTeX-style math delimiters.
    • Include examples to show how \(...\) and \[...\] can be used for inline and block math.
Benefits:
  • Makes Quarto’s capabilities more transparent to users.
  • Enhances usability for academic and technical writing by providing official guidance on:
    • LaTeX-style math delimiters for consistency.

Related Discussions:

This request builds upon Discussion #11753 on Quarto’s GitHub platform.

Thank you for considering this enhancement to the documentation!

主要言語
JavaScript
スター
6k
フォーク
458
平均マージ
1日 9時間
マージ済み PR(30日)
41

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

quarto-dev/quarto-cli のほかの issue

quarto-dev/quarto-cli の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。