Docsify v5.0.0-rc.3：支持 GitHub 风格的提示框

文章主旨：Docsify v5.0.0-rc.3 主要引入了 GitHub 风格的提示框（Callouts），并优化了 Markdown 片段提取、侧边栏导航和 Slug 生成等细节，提升文档阅读体验。

关键要点：

• 新增 GitHub 风格的提示框（Callouts），支持五种类型：CAUTION、IMPORTANT、NOTE、TIP、WARNING。
• 旧版本语法 !> 和 ?> 已废弃，分别被替换为 > [!IMPORTANT] 和 > [!TIP]。
• 改进 Markdown 片段提取功能，现在支持提取代码片段以外的内容（例如通过 :fragment 参数指定片段）。
• 优化侧边栏导航和 Slug 生成，提升稳定性与流畅性。
• 依赖升级、样式优化与文档完善一并完成。

内容结构：

• 支持 GitHub 风格的提示框（Callouts）：
  • 此功能基于块引用语法，用于强调关键信息，避免旧版本自定义样式在 GitHub 上无法渲染的问题。
  • 提供五种警报类型及其语法示例：CAUTION、IMPORTANT、NOTE、TIP、WARNING。
  • 旧版语法 !> 和 ?> 已废弃，分别由 > [!IMPORTANT] 和 > [!TIP] 替代。
• 支持提取 Markdown 中的片段内容：
  • 过去仅支持代码片段提取（通过 :type=code :fragment），现在扩展为可提取 Markdown 片段。
  • 示例中展示了通过 :fragment 参数引用 PHP 文件中特定片段的方式。

文章总结：此次更新增强了文档书写与阅读的一致性，尤其提示框功能使关键信息更突出，同时细节优化提升了整体可用性。

将安全融入软件开发的每一步 | DevSecOps

了解更多

鲁飞

查看原文：Docsify v5.0.0-rc.3：支持 GitHub 风格的提示框

文章来源：

鲁飞

扫码关注公众号