中文介绍

This repository provides a comprehensive guide and toolset for writing academic papers in Chinese, such as the localization and sorting of Chinese citations and bibliographies, conversion of Chinese quotation marks, and correcting spaces between Chinese and English characters. With the help of these templates and scripts, you can write your academic papers in Markdown, and convert them into various formats like Word, HTML, LaTeX/PDF, Typst/PDF, EPUB, and Reveal.js slides via Quarto.

• Render Multiple Formats: Render DOCX, HTML, PDF (LaTeX), PDF (Typst), EPUB, and Reveal.js slides at once with the same source file, and PDF can be customized for print or with watermark.
• Localize Chinese Bibliographies: Change et al. to 等 and other English localization strings to Chinese in citations and references, both author-date and numeric styles are supported.
• Sort Chinese Bibliographies: Sort Chinese bibliographies by Pinyin while keeping non-Chinese entries alphabetized, and customize whether Chinese entries appear first or last.
• Correct Chinese Quotes: Automatically tailor quotation marks for DOCX, HTML/EPUB bibliographies, LaTeX body text, LaTeX headings, and Typst outputs.
• Correct Spaces: Improve copywriting, correct spaces, words, and punctuations between CJK and Western text.
• Extract Bibliographies: Filter cited references to a CSL JSON file and copy cited attachments to a specified directory.
• Generate Backlinks: Generate backlinks for bibliography entries to the corresponding citations.
• Remove DOI Hyperlinks: Remove DOI hyperlinks formatted by citeproc if they are not needed in the bibliography.
• Align Text Blocks: Right- or center-align specific text in DOCX, PDF, HTML, EPUB, and Typst.
• Custom Fonts: Use custom fonts in DOCX, PDF, HTML, EPUB, and Typst.

• Quarto, with Pandoc included, and you can install TinyTeX via quarto install tinytex --update-path.
• Python, and the following packages:
  • autocorrect_py
  • pypinyin
  • panflute
• R, and the following packages:
  • rmarkdown
  • knitr
  • ggplot2

This project uses a Makefile to manage the build process. Here are the available commands:

• make or make all: Render DOCX, HTML, EPUB, PDF (LaTeX), PDF (Typst) and Reveal.js slides at once.
• make docx: Render DOCX.
• make html: Render HTML.
• make pdf: Render PDF via LaTeX.
• make typst: Render PDF via Typst.
• make epub: Render EPUB.
• make slides: Render Reveal.js slides.
• make print: Render PDF for print.
• make watermark: Render PDF with watermark.
• make citebib: Extract all cited references into citebib.json (filtered CSL JSON).
• make citedoc: Copy cited reference files to a specified directory.
• make clean: Remove auxiliary and output files.

• auto-correct: Improve copywriting, correct spaces, words, and punctuations between CJK and English with AutoCorrect.
• citation-backlinks: Generate backlinks for bibliography entries to the corresponding citations.
• capitalize-subtitle: Capitalize the first word after colons or em dashes inside bibliography subtitles, following APA style.
• citation-tools: Extract citation keys to a filtered CSL JSON file, and copy cited reference files to a specified directory.
• cnbib-quotes: Process quotes for Chinese bibliographies in HTML and EPUB outputs.
• confetti: Send some 🎊 in Reveal.js slides.
• custom-fonts: Use custom fonts in DOCX, PDF, HTML, EPUB, and Typst.¹
• docx-quotes: Convert straight angle quotation marks to curly quotation marks in DOCX.
• format-md: Preprocess Markdown files for conversion with Quarto.
• get-bib: Extract all bibliographies cited in the document as a BibLaTeX file.²
• ignore-softbreaks: Emulate Pandoc’s extension east_asian_line_breaks in Quarto.
• latex-body-quotes: Replace Chinese corner quotes with guillemets in LaTeX body text.
• latex-header-quotes: Keep LaTeX/PDF headers readable while rendering body quotes correctly.
• links-to-citations: Remove local links but keep the link text as normal citations.
• localize-cnbib: Localize Chinese bibliographies, change et al. to 等 and other English localization strings to Chinese.
• no-first-paragraph: Remove the First Paragraph style by applying Body Text to all paragraphs in DOCX.
• remove-doi-hyperlinks: Remove DOI hyperlinks formatted by citeproc in the bibliography.³
• remove-spaces: Remove spaces before or after Chinese characters in DOCX.
• sort-bib: Sort bibliographies by grouping Chinese entries (sorted by Pinyin) and non-Chinese entries (alphabetical).
• sort-citations: Reorder multi-entry citation clusters so English items precede Chinese items (sorted by Pinyin) while keeping prefixes/suffixes with their citations.
• text-align: Right- or center-align specific blocks across DOCX, PDF, HTML, EPUB, and Typst outputs.
• typst-quotes: Replace Chinese corner quotes for Typst output so the PDF looks correct.

This project is licensed under the MIT License, see the LICENSE file for details.