From 3236fc79f2a31e2f8d6bbcb5ef1aa53aab6ecbf1 Mon Sep 17 00:00:00 2001 From: Andrew Heiss Date: Mon, 3 Jun 2024 12:39:38 -0400 Subject: [PATCH] Add documentation for no counting --- README.md | 16 ++++++++++++++++ README.qmd | 12 ++++++++++++ 2 files changed, 28 insertions(+) diff --git a/README.md b/README.md index 3fc3354..763a087 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ - [Usage](#usage) - [Terminal output](#terminal-output) - [Shortcodes](#shortcodes) + - [No counting](#no-counting) - [Appendices](#appendices) - [Example](#example) - [Credits](#credits) @@ -175,6 +176,21 @@ title: Something subtitle: "{{< words-sum body-note-ref >}} words" ``` +### No counting + +If you want to omit text from the word count, you can include it in a +[fenced +div](https://quarto.org/docs/authoring/markdown-basics.html#sec-divs-and-spans) +with the `{.no-count}` class: + +``` markdown +::: {.no-count} + +These words don't count. + +::: +``` + ### Appendices In academic writing, it’s often helpful to have a separate word count diff --git a/README.qmd b/README.qmd index c3e63f1..4f0738e 100644 --- a/README.qmd +++ b/README.qmd @@ -118,6 +118,18 @@ title: Something subtitle: "{{{< words-sum body-note-ref >}}} words" ``` +### No counting + +If you want to omit text from the word count, you can include it in a [fenced div](https://quarto.org/docs/authoring/markdown-basics.html#sec-divs-and-spans) with the `{.no-count}` class: + +````markdown +::: {.no-count} + +These words don't count. + +::: +```` + ### Appendices In academic writing, it's often helpful to have a separate word count for content in the appendices, since things there don't typically count against journal word limits. [Quarto has a neat feature for automatically creating an appendix section](https://quarto.org/docs/authoring/appendices.html) and moving content there automatically as needed. It does this (I think) with a fancy Lua filter.