pandoc-access-theme/README.md

15 lines
1.1 KiB
Markdown

# pandoc-access-theme
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)
# Disclaimer
While I have done my best to ensure this theme is WCAG AA compliant, I am not an accessbility or design expert. You should double check this theme yourself and ensure it meets your needs/obligations. By using it, you take full liability for any non-compliance issues in your application.