更新日志

0.6.0 - 2024-05-23

依赖项

新增

✨ 创建自定义指令

您可以使用 sd_custom_directives 配置选项在您的 conf.py 文件中添加自定义指令，并设置默认选项值

sd_custom_directives = {
  "dropdown-syntax": {
    "inherit": "dropdown",
    "argument": "Syntax",
    "options": {
      "color": "primary",
      "icon": "code",
    },
  }
}

键是您要添加的新指令名称，值是一个字典，包含以下键：

  • inherit：要继承的指令（例如 dropdown）

  • argument：默认参数（可选，仅适用于接受单个参数的指令）

  • options：指令的默认选项字典（可选）

由 @chrisjsewell 在 PR #194 中贡献

✨ 通过 URL 查询参数同步标签页

现在可以通过向 URL 添加查询参数来选择同步标签页，例如对于该同步组，可以使用 ?code=python

.. tab-set-code::

    .. literalinclude:: snippet.py
        :language: python

    .. literalinclude:: snippet.js
        :language: javascript

每个组最后选择的标签页键也会持久化到 SessionStorage 中

由 @mikemckiernan 和 @chrisjsewell 在 PR #196 中贡献

改进

  • 👌 默认情况下，内部链接卡片使用引用名称，由 @gabalafou 在 PR #183 中贡献

  • 👌 提高 JS 函数名称的特异性，由 @danirus 在 PR #153 中贡献

  • 👌 移除 sphinx >= 7.1 中重复的 CSS 哈希，由 @chrisjsewell 在 PR #193 中贡献

👌 改进 dropdown 标题栏

有三个可见的更改：

  1. “默认”行为是将右侧的 chevron 图标从右向（关闭）变为向下向（打开），而不是从向下向（关闭）变为向上向（打开）。打开/关闭时还有一个旋转过渡效果。旧的默认行为可以通过使用新的 :chevron: down-up 指令选项来保留。

  2. 前缀图标（可选）、标题文本和 chevron 状态图标现在都对齐得更好

  3. 顶部/底部内边距现在为 0.5em 而不是 1em

PR 还引入了三个新的 CSS 变量来控制下拉菜单的字体大小

--sd-fontsize-tabs-label: 1rem;
--sd-fontsize-dropdown-title: 1rem;
--sd-fontweight-dropdown-title: 700;

在内部，HTML / CSS 已更改，使得标题现在是一个 inline-flex 框，带有三列，使用 justify-content: space-between 排列

图标（可选）

文本 (flex-grow: 1)

状态 chevron 图标

此外，状态 chevron 图标以前是两个不同的 SVG（其中一个隐藏），但现在是一个在打开/关闭时旋转的 SVG。

由 @chrisjsewell 在 PR #192 中贡献

修复

内部

完整更新日志: https://github.com/executablebooks/sphinx-design/compare/v0.5.0…v0.6.0

0.5.0 - 2023-07-27

完整更新日志: https://github.com/executablebooks/sphinx-design/compare/v0.4.1…v0.5.0

v0.4.0 - 2023-04-13

完整更新日志: https://github.com/executablebooks/sphinx-design/compare/v0.3.0…v0.4.0

增强功能

版本升级

此版本的贡献者

以下人员贡献了讨论、新想法、代码和文档贡献以及审查。请参阅 我们对报告中贡献的定义。

(此版本的 GitHub 贡献者页面)

v0.3.0 - 2022-08-22

  • ⬆️ 更新 Materials Design Icons 至 v4.0.0-46-gc9e5528，感谢 @2bndy5 (PR #69)

  • 🐛 修复: dropdown/tab-item :name: 选项 (PR #91)

  • 🐛 修复: 针对非 HTML 格式的文档构建 (PR #88)

  • 👌 改进: 添加卡片选项 class-img-top/class-img-bottom (PR #92)

  • 👌 改进: 添加 link-alt 以修复卡片链接可访问性 (PR #89)

    • 为 card (和 grid-item-card) 指令添加了 link-alt 选项，以便为链接分配可识别的名称（供屏幕阅读器使用）。

  • 👌 改进: 使标签页 ID 确定化 (PR #93)

    • 使用递增的索引，而不是 UUID

  • 🔧 维护: 修复 docutils PendingDeprecationWarning (PR #94)

  • 📚 文档: 更新 font awesome 图标 (PR #64)

完整更新日志: https://github.com/executablebooks/sphinx-design/compare/v0.2.0…v0.3.0

v0.2.0 - 2022-06-14

  • ⬆️ 支持 Sphinx v5，移除 v3

  • ⬆️ 添加 Python 3.10 支持

完整更新日志: https://github.com/executablebooks/sphinx-design/compare/v0.1.0…v0.2.0

v0.1.0 - 2022-04-21

  • ✨ 新功能: 添加 material design icons roles，感谢 @2bndy5 在 PR #41 中贡献

  • ⬆️ 升级: octicons 至 v16.1.1，感谢 @pocek 在 PR #43 中贡献

  • 🐛 修复: 卡片标题中的链接问题，由 @chrisjsewell 在 PR #59 中贡献

  • 🐛 修复: 缺少卡片链接时出现异常的问题，由 @chrisjsewell 在 PR #60 中贡献

  • 🔧 维护: 从 setuptools 迁移到 flit 进行包构建，由 @chrisjsewell 在 PR #58 中贡献

  • 🔧 维护: 移除 furo 特定的样式表，感谢 @pradyunsg 在 PR #22 中贡献

完整更新日志: https://github.com/executablebooks/sphinx-design/compare/v0.0.13…v0.1.0

v0.0.13 - 2021-10-27

✨ 新功能: 添加 icon far role (PR #35)，感谢 @OriolAbril

👌 改进: 标签页的样式 (PR #21)，感谢 @pradyunsg

👌 改进: 正确移除下拉卡片主体的边框 (PR #23)，感谢 @pradyunsg

🐛 修复: sd-outline-* 类的颜色 (PR #25)

v0.0.11 - 2021-09-08

✨ 新功能: 为 button-ref 指令添加 ref-type 选项

v0.0.10 - 2021-08-08

✨ 新功能: 为 grid-item 指令添加 child-direction 和 child-align 选项

✨ 新功能: 为 card 指令添加 img-background 选项

v0.0.9 - 2021-06-08

♻️ 重构: 将 test_sd_hide_root_title 更改为 sd_hide_title front-matter

👌 改进: 下拉菜单 chevron 图标

v0.0.8 - 2021-06-08

✨ 新功能: 添加 test_sd_hide_root_title 配置选项以隐藏根标题。

👌 改进: sd-card-hover:hover 添加 scale 101%

📚 文档: 更新 landing page

v0.0.7 - 2021-05-08

✨ 新功能: 为 grid 指令添加 reverse 选项

✨ 新功能: 添加动画

v0.0.6 - 2021-04-08

✨ 新功能: 添加 card-carousel 指令

v0.0.5 - 2021-28-07

👌 改进: 使 octicon 的大小可变

v0.0.4 - 2021-28-07

👌 改进: 允许 auto 用于栅格列

v0.0.3 - 2021-26-07

👌 改进: 添加更多 CSS 类并添加文档 📚

v0.0.2 - 2021-23-07

改进文档 📚

v0.0.1 - 2021-22-07

初始发布 🎉