summaryrefslogtreecommitdiff
path: root/paper/lua-filters/wordcount/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'paper/lua-filters/wordcount/README.md')
-rw-r--r--paper/lua-filters/wordcount/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/paper/lua-filters/wordcount/README.md b/paper/lua-filters/wordcount/README.md
new file mode 100644
index 0000000..45efc2f
--- /dev/null
+++ b/paper/lua-filters/wordcount/README.md
@@ -0,0 +1,11 @@
+# wordcount
+
+This filter counts the words in the body of a document (omitting
+metadata like titles and abstracts), including words in code.
+It should be more accurate than `wc -w` run directly on a
+Markdown document, since the latter will count markup
+characters, like the `#` in front of an ATX header, or
+tags in HTML documents, as words.
+
+To run it, `pandoc --lua-filter wordcount.lua myfile.md`.
+The word count will be printed to stdout.