This package includes a collection of accessible themes for pygments based on multiple open-source syntax highlighting themes. The images below show all the themes side by side.
:sparkles: To see examples of the themes in action visit our online demo :sparkles:
[!Note] What do we mean by accessible? In this context we are specifically referring to themes which meet the WCAG 2.1 criteria for color contrast. Some themes included are also color-blind friendly.
The following themes are AAA compliant with WCAG 2.1 criteria for color contrast.
a11y-darka11y-high-contrast-darkpitaya-smoothie - Color-blind friendly.github-light - Color-blind friendly.github-dark - Color-blind friendly.github-light-colorblind - Color-blind friendly.github-dark-colorblind - Color-blind friendly.github-light-high-contrast - Color-blind friendly.github-dark-high-contrast - Color-blind friendly.gotthard-dark - Color-blind friendly.The following themes are AA compliant with WCAG 2.1 criteria for color contrast.
a11y-lighta11y-high-contrast-lightgotthard-light - Color-blind friendly.blinds-light - Color-blind friendly.blinds-dark - Color-blind friendly.greative - Accessible to most forms of colorblindness and low light settings.accessible-pygments is available through pip and conda.
You can install it through the following commands:
conda install -c conda-forge accessible-pygments
# if you prefer using mamba
mamba install -c conda-forge accessible-pygments
pip install accessible-pygments
If you prefer to install the themes directly from the source:
# clone the repository
git clone git@github.com:Quansight-Labs/accessible-pygments.git
cd accessible-pygments
pip install .
If you want to directly use the themes in your code, you can do so by importing the theme and passing it to the style argument of the HtmlFormatter class.
from pygments.formatters import HtmlFormatter
HtmlFormatter(style='a11y-light').style
<class 'accessible-pygments.A11yLight'>
You will need to add accessible-pygments as a dependency to your documentation:
# for example if using a pyproject.toml file
dependencies=["accessible-pygments"]
Modify your conf.py file to specify the accessible-pygments style:
"pygments_style": "a11y-light"
Build your documentation as usual.
You can find our contribution guides on CONTRIBUTING.md. We aim to build a safe and inclusive community, so we have a Code of Conduct that we ask everyone to follow.
We want to thank the following sources for being the source of inspiration for one or more themes that are available in this repository,
accessible-pygments is licensed under the OSI BSD-3 Clause license.
FAQs
A collection of accessible pygments styles
We found that accessible-pygments demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.