可访问Pygments主题

目录

• 可访问Pygments主题
  • 目录
  • 可访问性详细信息 ♿️
    • WCAG 2.1 - AAA兼容
    • WCAG 2.1 - AA兼容
  • 文档 📖
    • 安装 💻
    • 直接在您的代码或应用程序中使用主题
    • 在Sphinx文档中使用主题
  • 开发和贡献 🌱
  • 致谢 🤝
  • 许可 📑

本包包含基于多个开源语法高亮主题的 pygments 易访问主题集合。下面的图片展示了所有主题并排显示。

:sparkles: 要查看主题的实际效果，请访问我们的在线演示 访问我们的在线演示 :sparkles

可访问性详细信息 ♿️

[!注意] 我们所说的“易访问”是指符合 WCAG 2.1 颜色对比度标准 的主题。其中一些主题也适合色盲用户。

WCAG 2.1 - AAA兼容

以下主题符合 WCAG 2.1 颜色对比度标准 的 AAA 级别。

• a11y-dark
• a11y-high-contrast-dark
• pitaya-smoothie - 适合色盲用户。
• github-light - 适合色盲用户。
• github-dark - 适合色盲用户。
• github-light-colorblind - 适合色盲用户。
• github-dark-colorblind - 适合色盲用户。
• github-light-high-contrast - 适合色盲用户。
• github-dark-high-contrast - 适合色盲用户。
• gotthard-dark - 适合色盲用户。

WCAG 2.1 - AA兼容

以下主题符合 WCAG 2.1 颜色对比度标准 的 AA 级别。

• a11y-light
• a11y-high-contrast-light
• gotthard-light - 适合色盲用户。
• blinds-light - 适合色盲用户。
• blinds-dark - 适合色盲用户。
• greative - 对大多数色盲类型和低光环境都易访问。

文档 📖

安装 💻

accessible-pygments 通过 pip 和 conda 提供。

您可以使用以下命令进行安装

conda install -c conda-forge accessible-pygments

# if you prefer using mamba
mamba install -c conda-forge accessible-pygments

pip install accessible-pygments

如果您希望直接从源安装主题

# clone the repository
git clone git@github.com:Quansight-Labs/accessible-pygments.git
cd accessible-pygments

pip install .

直接在您的代码或应用程序中使用主题

如果您想直接在代码中使用这些主题，可以通过导入主题并将其传递给 HtmlFormatter 类的 style 参数来实现。

from pygments.formatters import HtmlFormatter
HtmlFormatter(style='a11y-light').style
<class 'accessible-pygments.A11yLight'>

在Sphinx文档中使用主题

1. 您需要将 accessible-pygments 添加为文档的依赖项

   # for example if using a pyproject.toml file
   dependencies=["accessible-pygments"]
   

2. 修改您的 conf.py 文件以指定 accessible-pygments 风格

   "pygments_style": "a11y-light"
   

3. 按照常规方式构建您的文档。

开发和贡献 🌱

您可以在 CONTRIBUTING.md 上找到我们的贡献指南。我们致力于建立一个安全和包容的社区，因此我们有一个 行为准则，我们要求每个人都遵守。

致谢 🤝

我们想感谢以下来源为以下一个或多个主题提供灵感，这些主题可在本存储库中找到：

• a11y dark and light syntax highlighting.
• pitaya smoothie VSCode 主题.
• github VSCode 主题.
• gotthard VSCode 主题.
• blinds VSCode 主题.
• greative VSCode 主题.

许可 📑

accessible-pygments 使用 OSI BSD-3 Clause 许可证。