当前位置: 首页 > news >正文

常见文档工具对比和选择

前言

文档工具的本质,其实都是将我们的文档内容标准化,在互联网环境上的文档,一般目前比较主流的是生成文档的 html 网页内容,而文档内容的作者都比较倾向于使用纯文本的 Markdown 进行书写,所以文档工具的核心内容主要就是将 Markdown 转换为一个 html 的网站内容。

目前市面上比较常见的工具有如下这些:

  • Gitbook
  • Docsify
  • Docute
  • Docusaurus
  • Hexo
  • Loppo
  • Vuepress
  • Vitepress

1. GitBook

首先不推荐 GitBook,原因是项目已经几年没有维护了,列在此处,仅做对比。

GitBook 的项目地址为 GitBook GitHub (opens new window),官网为 GitBook 官网 (opens new window)。

页面效果如下图:

2. Docsify

Docsify 的项目地址为 Docsify GitHub (opens new window),官网为 Docsify 官网 (opens new window)。

页面效果如下,有一个封面页和正文页:

Docsify 是一个文档网站生成器,它依赖于 node.js,但不生成静态 html 文件,运行速度快,有很多插件。

环境配置难度低于编译型工具,同时有一个很炫酷的封面页,很好看,支持页内搜索和搜索插件,但它不会生成静态 html 文件,不利于搜索引擎收录,并且对于段落引用不支持,很多文档中的“解释”、“提示”项难以实现。

3. Docute

不推荐 Docute,原因同样是项目已不再维护。

Docute 项目地址为 Docute GitHub (opens new window),官网已不可访问。

4. Docusaurus

Docusaurus 项目地址为 Docusaurus GitHub (opens new window),官网为 Docusaurus 官网(opens new window)

页面效果如下,有一个封面页和正文页:

Docusaurus 可以帮助你在极短时间内搭建漂亮的文档网站。它依赖于 node.js,同时前端框架为 React,也支持 TypeScript,能够开箱即用。

它有着漂亮的首页,支持不同的主题切换,支持页面搜索和搜索插件,支持连续的引用符号 < 生成好看的段落引用,还能为每页生成元数据,利于搜索引擎收录。

5. HEOX

Hexo 项目地址为 Hexo GitHub (opens new window),官网为 Hexo 官网 (opens new window)。

Hexo 是一个快速、简洁、高效的博客框架,基于 node.js,由于本身只是框架,更多功能还需要主题插件支持,它更适合用作博客网站,而非文档网站。 

6. Loppo

Loppo 项目地址为 Loppo GitHub (opens new window),示例网站为 Loppo 示例 (opens new window)。

页面效果如下:

7. VuePress

Vuepress 项目地址为 Vuepress GitHub (opens new window),官网为 Vuepress 官网 (opens new window)。

页面效果如下,有一个封面页和正文页:

Vuepress 依赖于 node.js,有很多插件,会进行本地编译,为每个页面生成单独的 html 文件,有利于搜索引擎收录,支持页内搜索和搜索插件,支持段落引用扩展语法 :::tip

8. VitePress

由 Vite 和 Vue 驱动的静态站点生成器

页面效果如下,有一个封面页和正文页:

 服务器即时启动,闪电般的热更新,还可以使用基于 Vite 生态的插件。

相关文章:

  • 北京网站建设多少钱?
  • 辽宁网页制作哪家好_网站建设
  • 高端品牌网站建设_汉中网站制作
  • 解锁SQL基础应用新境界:从入门到精通的扩展实践指南(SQL扩展)
  • 1765asp.net古镇旅游网站VS开发sqlserver数据库web结构c#编程web网页设计
  • 华为OD机试真题 - 抢7游戏(Python/JS/C/C++ 2024 D卷 100分)
  • 小琳AI课堂:Nezha模型:基于Transformer的中文预训练语言模型优化与进展
  • ​数据链路层——流量控制可靠传输机制 ​
  • 高职人工智能训练师边缘计算实训室解决方案
  • 【Unity3D】如何用MMD4Mecanim插件将pmx格式模型转换为fbx格式模型
  • jEasyUI 创建带复选框的树形菜单
  • 《高校教育管理》
  • 兔英语语法体系——观后笔记
  • goby/xray批量导入自定义poc(附2024红队POC)
  • 线程实现的几种方式
  • Android SystemUI组件(06)导航栏创建分析虚拟按键
  • 在Linux中从视频流截取图片帧(ffmpeg )
  • 去除恢复出厂设置中UI文字显示
  • Centos6.8 使用rpm安装mysql5.7
  • Docker容器管理
  • JavaSE小实践1:Java爬取斗图网站的所有表情包
  • Js基础——数据类型之Null和Undefined
  • miniui datagrid 的客户端分页解决方案 - CS结合
  • php中curl和soap方式请求服务超时问题
  • Promise面试题,控制异步流程
  • Redis学习笔记 - pipline(流水线、管道)
  • 回顾2016
  • 基于 Babel 的 npm 包最小化设置
  • 基于OpenResty的Lua Web框架lor0.0.2预览版发布
  • 深度学习入门:10门免费线上课程推荐
  • 使用 QuickBI 搭建酷炫可视化分析
  • 使用API自动生成工具优化前端工作流
  • 手写双向链表LinkedList的几个常用功能
  • 协程
  • 用jQuery怎么做到前后端分离
  • 微龛半导体获数千万Pre-A轮融资,投资方为国中创投 ...
  • ​2021半年盘点,不想你错过的重磅新书
  • ​无人机石油管道巡检方案新亮点:灵活准确又高效
  • (16)Reactor的测试——响应式Spring的道法术器
  • (2)空速传感器
  • (2.2w字)前端单元测试之Jest详解篇
  • (23)Linux的软硬连接
  • (Java入门)学生管理系统
  • (ZT)一个美国文科博士的YardLife
  • (超详细)2-YOLOV5改进-添加SimAM注意力机制
  • (十八)三元表达式和列表解析
  • .NET C# 配置 Options
  • .NET Core WebAPI中使用Log4net 日志级别分类并记录到数据库
  • .NET 漏洞分析 | 某ERP系统存在SQL注入
  • .NET 使用 ILMerge 合并多个程序集,避免引入额外的依赖
  • .NET 使用 ILRepack 合并多个程序集(替代 ILMerge),避免引入额外的依赖
  • .NET 应用架构指导 V2 学习笔记(一) 软件架构的关键原则
  • .Net 中的反射(动态创建类型实例) - Part.4(转自http://www.tracefact.net/CLR-and-Framework/Reflection-Part4.aspx)...
  • .NET+WPF 桌面快速启动工具 GeekDesk
  • .NET单元测试
  • .NET设计模式(7):创建型模式专题总结(Creational Pattern)
  • .NET值类型变量“活”在哪?
  • /etc/sudoer文件配置简析