Update README.md

This commit is contained in:
alphonse 2026-05-23 16:30:07 +00:00
parent cefc56b5f1
commit 08c99eaea6
1 changed files with 9 additions and 1 deletions

View File

@ -1,3 +1,11 @@
# pandoc-access-theme # pandoc-access-theme
A pandoc syntax highlighting theme that is WCAG AA compliant. 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)