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

Đang mở Phù hợp với người mới
#12,263 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
latex, markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với phần «equations» trong tài liệu «Markdown basics» của quarto.org được liên kết trong issue, và xác minh cách extension markdown+tex_math_single_backslash được trình bày. Cập nhật tài liệu với các delimiter (...) và [...] cùng các ví dụ; hoàn tất nghĩa là người dùng có thể tìm thấy thiết lập của extension và hiểu cách sử dụng inline so với dạng block.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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!

Ngôn ngữ chính
JavaScript
Star
6k
Fork
458
Merge trung bình
1 ngày 9 giờ
Pull request đã merge (30 ngày)
41

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của quarto-dev/quarto-cli

Tất cả issue của quarto-dev/quarto-cli

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.