首页
/ Vocs 1.0.0 发布:现代化文档工具的重大升级

Vocs 1.0.0 发布:现代化文档工具的重大升级

2025-07-03 04:12:04作者:魏侃纯Zoe

Vocs 是一个现代化的文档工具,它基于 React 和 MDX 构建,提供了优雅的文档编写体验和强大的功能特性。最新发布的 1.0.0 版本标志着该项目已经趋于稳定,并带来了一系列重要的改进和新功能。

核心升级内容

  1. React 19 支持
    1.0.0 版本将 React 和 React DOM 的依赖要求升级到了 19 版本,这意味着开发者可以享受到 React 最新版本带来的性能优化和新特性。

  2. Tailwind CSS v4 集成
    新版本增加了对 Tailwind CSS v4 的支持,提供了更现代化的样式处理方案。开发者现在可以更方便地自定义文档样式。

  3. 元数据管理改进
    移除了 vocs/head 入口点,转而支持使用 React 原生的 <head> 组件来管理文档的元数据,这使元数据处理更加直观和符合 React 的开发模式。

代码高亮与交互增强

  1. Shiki 高亮引擎升级
    1.0.0 版本从 rehype-pretty-code 迁移到了 rehype-shiki,并升级到了 Shiki 1.0.0-beta,带来了更稳定和高效的代码高亮体验。

  2. Twoslash 集成改进
    对 TypeScript 代码示例的交互支持进行了优化,现在默认会在语法错误时抛出异常,同时支持 // @noErrors 标记来禁用这一行为。

  3. 代码片段功能增强
    新增了"虚拟文件"代码片段支持,并引入了区域标记功能,使代码示例的组织更加灵活。

用户体验优化

  1. 搜索功能改进
    修复了索引页搜索问题,并增加了对包含相对导入页面的搜索支持,使文档搜索更加全面准确。

  2. 导航体验提升
    优化了侧边栏的交互逻辑,现在可点击的侧边栏项在被点击时会自动展开,提高了导航的便利性。

  3. 移动端适配
    针对小屏幕设备优化了顶部导航栏的文本换行,确保在各种设备上都能获得良好的阅读体验。

构建与部署

  1. Vercel 构建输出兼容
    新版本遵循 Vercel 的构建输出 API,实现了零配置的 Vercel 部署支持。

  2. 子路径支持
    增加了 basePath 配置属性,使文档能够部署在子路径下(如 GitHub Pages 等场景)。

  3. 独立搜索索引构建
    新增了 search-index CLI 命令,允许单独构建搜索索引,提高了大型文档站的构建效率。

样式与主题

  1. 主题系统增强
    支持通过 theme.colorScheme 配置颜色方案,并增加了对代码块和内联代码字体家族的自定义支持。

  2. 横幅支持
    新增了 banner 配置属性,允许在文档顶部显示自定义横幅,适合用于公告或重要提示。

Vocs 1.0.0 版本的发布标志着该项目已经成熟稳定,为技术文档的创建和维护提供了更加完善和强大的工具集。无论是个人项目还是企业级文档,Vocs 都能提供出色的支持和体验。

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

热门内容推荐

最新内容推荐

项目优选

收起
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
52
444
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
349
382
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
873
517
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
179
264
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
131
185
kernelkernel
deepin linux kernel
C
22
5
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
7
0
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
335
1.09 K
harmony-utilsharmony-utils
harmony-utils 一款功能丰富且极易上手的HarmonyOS工具库,借助众多实用工具类,致力于助力开发者迅速构建鸿蒙应用。其封装的工具涵盖了APP、设备、屏幕、授权、通知、线程间通信、弹框、吐司、生物认证、用户首选项、拍照、相册、扫码、文件、日志,异常捕获、字符、字符串、数字、集合、日期、随机、base64、加密、解密、JSON等一系列的功能和操作,能够满足各种不同的开发需求。
ArkTS
33
0
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.08 K
0