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 文件中特定片段的方式。
- 过去仅支持代码片段提取(通过
文章总结:此次更新增强了文档书写与阅读的一致性,尤其提示框功能使关键信息更突出,同时细节优化提升了整体可用性。
鲁飞
鲁飞
扫码关注公众号
还在用多套工具管项目?
一个平台搞定产品、项目、质量与效能,告别整合之苦,实现全流程闭环。
查看方案
鲁飞的其他文章
通过微信开放平台授权获取公众号文章
如果想要实现一个将公众号文章搬运到某个社区中去发布的功能,除了使用爬虫等方法,还可以通过微信开放平台授权,调用官方接口来获取公众号文章。
Nginx目录浏览并进行美化
Nginx 作为一个高性能的 HTTP 和反向代理 web 服务器,默认不允许列出站点的整个目录,如果需要开启,可以通过配置打开此功能。
给你的项目增加 Git WebHooks
让你的项目支持 WebHooks,并且可以自定义 WebHooks 的规则。
使用 GitHub Actions 自动同步 Docker 镜像到 CNB
通过 GitHub Actions + skopeo + CNB 服务,构建一个可复用、自动化、支持多镜像同步的工具链,显著提升了镜像的可用性与部署效率。
解决Docker端口映射无法访问问题
这是一个过于沙雕的问题。
加入社区微信群
与行业大咖零距离交流学习
PMO实践白皮书
白皮书上线
白皮书上线