From 08c99eaea6b50ff0f627443f8cf44e835ac57752 Mon Sep 17 00:00:00 2001 From: alphonse Date: Sat, 23 May 2026 16:30:07 +0000 Subject: [PATCH] Update README.md --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7b4b396..93d46a8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ # pandoc-access-theme -A pandoc syntax highlighting theme that is WCAG AA compliant. \ No newline at end of file +A pandoc syntax highlighting theme that is WCAG AA compliant. + +This theme was loosely inspired by [Eric Bailey's a11y themes](https://github.com/ericwbailey/a11y-syntax-highlighting). As noted there, WCAG AAA standards somewhat preclude useful syntax highlighting for light themes. This theme is WCAG AA compliant; most colors meet the WCAG AAA standards for large text but only AA standards for small text. + +# Usage + +Simply download the `access-light.theme` file and place it in your working directory, or another location of your choice. Then run (e.g.) `pandoc -t input-file.txt -o output-file.html --highlight-style access-light.theme`. + +Documentation on Pandoc themes: [https://pandoc.org/demo/example33/15-syntax-highlighting.html](https://pandoc.org/demo/example33/15-syntax-highlighting.html) \ No newline at end of file