首页
/ Retype 3.10.0版本发布:文档工具的重大功能升级

Retype 3.10.0版本发布:文档工具的重大功能升级

2025-07-04 22:21:39作者:舒璇辛Bertina

Retype是一款现代化的文档生成工具,它能够将Markdown文件转换为美观、功能丰富的静态网站。作为技术文档编写和发布的利器,Retype在3.10.0版本中带来了多项重要改进和新功能,进一步提升了文档编写的灵活性和用户体验。

核心功能增强

注释功能全面升级

3.10.0版本引入了全新的注释语法,支持两种注释方式:

  1. 行内注释:使用%%包裹的文本将在渲染时被隐藏,非常适合在文档中添加开发者备注而不影响最终输出。例如:

    这是一个%%测试%%注释功能
    

    渲染后将只显示"这是一个注释功能"。

  2. 块级注释:可以注释掉整段内容,这在临时隐藏大段文本时特别有用。

导航控制更加灵活

新增的nextprev配置项为文档导航提供了更精细的控制能力。文档维护者现在可以:

  • 全局禁用或启用"上一页/下一页"导航
  • 针对特定页面单独设置导航行为
  • 自定义导航链接的显示逻辑

这项改进特别适合那些需要非线性格局的知识库或文档集。

内容提示多样化

新增的tip类型Callout为文档作者提供了更多表达方式。与现有的note、warning等类型一起,构成了完整的提示体系:

  • tip:用于技巧和小贴士
  • note:普通说明
  • warning:警告信息
  • danger:危险或重要警示

每种类型都有独特的视觉样式,帮助读者快速识别内容性质。

元数据与SEO优化

页面描述增强

新增的meta.description配置允许为每个页面单独设置描述信息,这对SEO优化至关重要。文档作者现在可以:

  • 为重要页面定制搜索引擎结果中显示的描述
  • 确保关键内容获得更好的搜索可见性
  • 避免自动截断导致的描述不完整问题

元素ID体系完善

3.10.0版本为模板中的关键元素添加了唯一ID属性,这带来了多重好处:

  1. 测试自动化:为UI自动化测试提供了可靠的定位方式
  2. 样式定制:通过CSS更精确地控制特定元素的样式
  3. 脚本交互:JavaScript可以更可靠地操作特定DOM元素

技术细节优化

锚点处理更智能

新版本改进了锚点(#)链接的处理逻辑:

  • 支持Obsidian风格的^anchor自定义锚点语法
  • 实现锚点链接的大小写不敏感匹配
  • 优化页面加载时的锚点滚动体验,确保平滑定位

代码展示改进

针对技术文档中的代码展示:

  • 为代码块添加translate="no"属性,防止翻译工具错误处理代码内容
  • 修复空代码块的高度渲染问题
  • 优化代码块的视觉呈现效果

列表属性支持

现在可以在列表项上添加通用HTML属性,例如:

- 列表项 {.custom-class data-id=123}

这在需要为特定列表项添加样式或数据属性时非常有用。

稳定性提升

3.10.0版本修复了多个关键问题:

  • 处理超大数值的order配置时不再抛出异常
  • 修正了图片尺寸解析时的边缘情况
  • 确保各种边界条件下的稳定渲染

这些改进使得Retype在处理复杂文档结构时更加可靠。

总结

Retype 3.10.0版本通过引入注释系统、增强导航控制、丰富内容提示类型等新功能,显著提升了文档编写的表达能力。同时,在元数据处理、代码展示和锚点链接等方面的优化,使得生成的文档网站更加专业和易用。对于技术文档团队和知识管理者来说,这次升级提供了更多工具来创建结构清晰、内容丰富的文档系统。

登录后查看全文
热门项目推荐

项目优选

收起
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
136
186
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
882
523
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
362
381
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
182
264
kernelkernel
deepin linux kernel
C
22
5
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.09 K
0
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
613
60
open-eBackupopen-eBackup
open-eBackup是一款开源备份软件,采用集群高扩展架构,通过应用备份通用框架、并行备份等技术,为主流数据库、虚拟化、文件系统、大数据等应用提供E2E的数据备份、恢复等能力,帮助用户实现关键数据高效保护。
HTML
118
78