Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TomBener committed Dec 3, 2024
1 parent d6b6d47 commit ed103e9
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ formats like Word, HTML, LaTeX, PDF, and ePub via Quarto with ease.
- **Correct Spaces**: Improve copywriting, correct spaces, words, and punctuations between CJK (Chinese, Japanese, Korean).
- **Extract Bibliographies**: Extract all bibliographies cited in the document as a BibLaTeX file.
- **Generate Backlinks**: Generate backlinks for bibliography entries to the corresponding citations.
- **Remove DOI Hyperlinks**: Remove DOI hyperlinks if they are not needed in the bibliography.

## Prerequisites

Expand All @@ -36,6 +37,10 @@ formats like Word, HTML, LaTeX, PDF, and ePub via Quarto with ease.

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

> [!NOTE]
> Currently [Lua filters](https://github.com/quarto-dev/quarto-cli/issues/7888) cannot be run after `--citeproc` in Quarto.
> As a workaround, some extensions are run on the command line in the Makefile. This can be improved in the future.
- `make` or `make all`: Render DOCX, HTML, PDF, ePub and Reveal.js slides at once.
- `make docx`: Render DOCX.
- `make html`: Render HTML.
Expand All @@ -49,19 +54,20 @@ This project uses a Makefile to manage the build process. Here are the available

## Tools

> [!NOTE]
> [!TIP]
> These tools can also be used individually in your Pandoc or Quarto project.
- [confetti](_extensions/confetti/): Send some 🎊 in Reveal.js slides.
- [ignore-softbreaks](_extensions/ignore-softbreaks/): Emulate Pandoc’s extension `east_asian_line_breaks` in Quarto.
- [latex-quotes](_extensions/latex-quotes/): Replaces Straight quotes with German quotes for intermediate in LaTeX output, and specific processing for headers to avoid issues in PDF bookmarks.
- [links-to-citations](_extensions/links-to-citations/): Remove local links but keep the link text as normal citations.
- [remove-spaces](_extensions/remove-spaces/): Remove spaces before or after Chinese characters in DOCX.
- [auto-correct](_extensions/auto-correct.py): Improve copywriting, correct spaces, words, and punctuations between CJK and English with AutoCorrect.
- [citation-backlinks](_extensions/citation-backlinks.lua): Generate backlinks for bibliography entries to the corresponding citations.
- [confetti](_extensions/confetti/): Send some 🎊 in Reveal.js slides.
- [format-md](_extensions/format-md.py): Preprocess Markdown files for conversion with Quarto.
- [get-bib](_extensions/get-bib.lua): Extract all bibliographies cited in the document as a BibLaTeX file.
- [ignore-softbreaks](_extensions/ignore-softbreaks/): Emulate Pandoc’s extension `east_asian_line_breaks` [in Quarto](https://github.com/quarto-dev/quarto-cli/issues/8520).
- [latex-quotes](_extensions/latex-quotes/): Replaces Straight quotes with German quotes for intermediate in LaTeX output, and specific processing for headers to avoid issues in PDF bookmarks.
- [links-to-citations](_extensions/links-to-citations/): Remove local links but keep the link text as normal citations.
- [localize-cnbib](_extensions/localize-cnbib.lua): Localize Chinese bibliographies, change `et al.` to `` and other English localization strings to Chinese.
- [remove-doi-hyperlinks](_extensions/remove-doi-hyperlinks.lua): Remove [DOI hyperlinks](https://github.com/jgm/pandoc/issues/10393) in the bibliography. Disabled by default. To enable it, add `-L _extensions/remove-doi-hyperlinks.lua` to the `FILTERS` variable in the Makefile, and remove `<text variable="DOI" prefix="DOI: "/>` in the CSL file.
- [remove-spaces](_extensions/remove-spaces/): Remove spaces before or after Chinese characters in DOCX.
- [sort-cnbib](_extensions/sort-cnbib.py): Sort Chinese bibliographies by Pinyin, and can be customized to sort Chinese entries first or last.

## License
Expand Down

0 comments on commit ed103e9

Please sign in to comment.