Skip to content

Commit

Permalink
Add documentation for no counting
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewheiss committed Jun 3, 2024
1 parent 76c35e6 commit 3236fc7
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- [Usage](#usage)
- [Terminal output](#terminal-output)
- [Shortcodes](#shortcodes)
- [No counting](#no-counting)
- [Appendices](#appendices)
- [Example](#example)
- [Credits](#credits)
Expand Down Expand Up @@ -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
Expand Down
12 changes: 12 additions & 0 deletions README.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 3236fc7

Please sign in to comment.