有一种方法，让你写好文档后，快速地让同事、用户和合作伙伴看到，这就是静态站点生成器。 

静态站点生成器是一种软件，用于创建不需要服务器端脚本的网站。这些网站由纯HTML文件组成，可能还包括CSS和JavaScript来增强功能和用户体验。你只需要编写Markdown文件，它可以快速地生成一个网站。 

现在静态站点生成器有很多， 这个视频就跟你分享我最近体验过的4个。

- 1 -

Jekyll

首先来看看Jekyll

Jekyll使用Ruby编程语言编写，由GitHub创始人之一Tom Preston创建。它使用Markdown作为默认的文本格式，并通过Liquid模板引擎生成静态HTML页面。Jekyll的设计理念是将文本内容与样式分离，便于管理和维护。它支持丰富的插件和主题，用户可以根据自己的需求进行定制。同时，Jekyll生成的静态网页加载速度快，对服务器资源要求低，具有高性能和安全性。它易于部署，只需将生成的文件上传到支持静态文件托管的地方，如GitHub Pages等即可。Jekyll广泛用于搭建个人博客、项目文档和小型网站。

- 2 -

MKDocs

第二个是MKDocs

MkDocs使用Markdown编写文档源文件，并通过YAML配置文件进行站点设置。它支持多种预设主题和自定义主题，允许用户根据需求定制文档的外观和感觉。MkDocs能够自动生成导航栏，方便用户在不同页面间导航。它还支持文档的版本控制，为不同版本的项目维护不同的文档集。此外，MkDocs拥有一个插件系统，允许用户扩展其功能，如添加搜索功能等。MkDocs生成的文档是静态HTML文件，可以部署在任何静态文件服务器上，包括GitHub Pages等。同时，它提供了一个开发服务器，支持实时预览文档效果，方便用户在编写文档时查看和调整。

- 3 -

Docusaurus

第三个是Docusaurus

Docusaurus由Facebook的工程师使用React开发的。Docusaurus主要用于快速搭建、部署和维护文档网站，如开发文档、技术文档、产品文档等。它使用Markdown编写内容，简化了文档网站的搭建过程，并提供了易于使用的命令行工具和预设模板。同时，Docusaurus支持多语言文档和版本控制，方便文档的维护和更新。Docusaurus允许开发者自定义整个文档网站的主题、布局、字体等，使文档网站更加个性化。Docusaurus自动生成的网站具有响应式布局，可以在不同设备上自适应显示。国内不少公司使用Docusaurus来搭建文档中心，比如：声网

- 4 -

VitePress

第四个是VitePress

如果你所在的团队对Vue比较熟悉， 那么VitePress是一个不错的选择。VitePress支持Markdown、Vue组件、自定义主题和前端配置，提供快速开发体验和简单的部署方案。它兼容Vue3和VueRouter4，允许开发者在Markdown文件中使用Vue组件，增加文档的交互性。VitePress内置了自动侧边栏生成、导航和搜索功能，方便用户浏览和查找文档内容。它还支持主题定制，开发者可以根据需求修改主题配置，添加导航栏、侧边栏等元素。VitePress适用于构建技术文档、博客、官方网站等类型的站点，帮助开发者快速搭建美观、易于维护的文档站点。

这个是我使用VitePress搭建的我们产品的文档中心。