Skip to content

a customized Quarto project for academic writing in both English and Chinese

Notifications You must be signed in to change notification settings

sun123zxy/sunquartex

Repository files navigation

SunQuarTeX

基于 Quarto 的自用中英文学术写作模板库.支持输出至 HTML、PDF/LaTeX、Beamer、MS Word、Github Flavored Markdown (GFM) 等多种格式,覆盖交叉引用、插图绘制、定理系统等多种功能.demo

Usage

安装及使用方法简述如下,细节可参见本仓库下的 Github Actions 配置文件.

请先安装 quarto-cli.测试 Quarto 版本为 1.5.57.

  • quarto render index-cnart.qmd
  • quarto render index-enart.qmd
  • quarto render index-cnpre.qmd
  • quarto render index-enpre.qmd

--to 参数可指定输出类型,包括 html, pdfbeamer, docx, gfm.每次渲染时应指定 --to 参数,或在文档中明确指定输出格式.

在文件头声明 lang=zhlang=en 即可调整语言.

关于 Computations

请确保安装恰当版本的 Python 和所需模块,如 Jupyter.

关于 PDF/LaTeX

需要输出 PDF 时,请确保已安装 Quarto 支持的 LaTeX 发行版.若无,可使用 quarto install tinytex --update-path 安装.

可在输出 PDF 前自行对 LaTeX 文件(*.tex)做进一步修正,再自行使用 xelatexbiber 输出 PDF.

若文档中包含 Mermaid、Graphviz 等 diagram 且需输出 PDF,请确保已安装 Chrome 或 Chromium.若无,可使用 quarto install tool chromium 安装.(参见 Quarto - Diagrams # Chrome Install

关于 TikZ / tikzcd

HTML / PDF / Beamer 格式现已支持 TikZ / tikzcd / quiver.如需在输出非 PDF / Beamer 格式下输出,请确保 XeLaTeX、dvisvgm、mutool 已在 PATH 中,且已安装需要使用的 LaTeX 宏包(目前 TikZ 中使用的宏包无法在渲染过程中自动安装).

  • 如使用 Quarto 自带的 TinyTeX:

    • 先输出一次 PDF 自动补全大部分所需宏包
    • 执行 tlmgr install dvisvgmtlmgr path add 下载 dvisvgm 并添加至 PATH.
    • Linux 执行 sudo apt install mupdf-tools
  • 在 Beamer 中使用时,所在幻灯片须添加 {.fragile} 标记.

  • 关于 mutool 必要性的一些说明:

    As of Ghostscript 10.01.0, this will no longer work due to the introduction of a new PDF interpreter. Therefore, an alternative conversion module based on mutool, a utility which is part of the MuPDF package, has been introduced. It’s automatically invoked if Ghostscript can’t be used and if a working mutool executable is present in a directory which is part of the system’s search path.

    来自 dvisvgm manual

若干说明

关于引用格式

默认全部使用 IEEE 格式.如需修改,请自定义 sun*****.cls_format.yml

关于标题

一般文档建议从二级标题开始编号(相关讨论);Beamer 的 slide-level 可自适应标题级数,但其分节固定从一级标题开始,见 Pandoc 文档.

关于 Beamer

理论上与文档格式兼容,可直接设置 --to=pdf 输出文稿版本.

关于 GFM

Quarto 1.5 后 GFM 格式处理表格有一些问题,cf. #9334.建议暂时停用 GFM.

尽管开启了 wrap: preserve,生成的 markdown 文件的换行行为仍可能不尽人意.这里是一些基于(vscode 查找 / 替换)正则表达式替换的后期补救措施:

  • (</span>)\s*\$\$ 替换为 $1\n$$$$:用于在定理紧邻 display math 时强制换行.

  • 考虑去除部分 HTML 标签(如<div>, <span>

    <div(([\s\S])*?)> 替换为空.

    </div> 替换为空.

  • \n\n\n 替换为 \n\n:删除多余空行.

注意:这一方案未对代码块做特殊处理.

Known Issues

  • Discussion #4598,Pandoc 不支持 CSL-M 导致无有效方法处理 GB/T 7714-2015 中按语言切换“等”、et al 省略字样的规定.

  • 【need-repro】表格与代码混排有时会使位置发生偏移,页面下部的代码块可能会溢出.

  • 通用的定理编号目前尚难以自定义,见 Discussion #5479

  • HTML 子图图像拉伸问题,似乎是因为没有设置 height: auto,有空去发个 issue.

Planning Enhancements

  • 考虑支持 callthmtikz 独立为插件.

About

a customized Quarto project for academic writing in both English and Chinese

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published