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

docusaurus初步体验

news 2025/8/20 7:33:13

背景

需要为www.codedriver.com.cn 构建一个在线文档，所以就查找相关内容，找到了 Docusaurus！

什么是 Docusaurus？

Docusaurus 是由 Facebook 开源的一个项目，专为那些希望快速搭建优质文档网站的开发者设计。它基于 React，支持 Markdown 格式，让内容创作变得轻而易举。

是一款静态站点生成器。释放了 React 的全部潜能，搭建了这款带有快速的客户端导航且交互性极佳的单页应用。即开即用的文档功能不仅仅局限于文档本身，还可用于创建任何类型的网站（个人网站、产品网站、博客、营销着陆页等）。

Docusaurus 设计之初就极度重视开发者及贡献者的体验。

使用 React 打造
使用 React 扩展与自定义
提供您自己的 React 组件，完全掌控网站的浏览体验
可扩展
使用基础模板搭建网站，随后使用进阶功能及插件
开放您的插件源码，与社群共享
开发者体验
立即撰写您的软件文档
统一配置文件可被轻松维护
更改后飞速增量编译并热加载
基于路由的代码及数据拆分
轻松发布至 GitHub Pages、Netlify、Vercel 及其他部署服务

Docusaurus 的优点

1️⃣ 易于上手：即使你不是前端专家，也能轻松使用。只需几个简单的步骤，你的网站就能上线。
2️⃣ 强大的自定义能力：你可以根据自己的需求，对网站进行个性化调整。
3️⃣ SEO 友好：帮助你的网站在搜索引擎上获得更好的排名。
4️⃣ 国际化支持：它支持多语言文档，让你的内容触及更广泛的受众。
5️⃣ 版本控制：方便地管理文档的不同版本。

其目标为——快速让用户找到需要的内容，并更好地了解您的产品。我们将与您分享我们的最佳实践，帮助您正确构建自己的文档网站。

为每条路径静态生成 HTML 文件
指定页面 SEO 来帮助您的用户快速查阅官方以解决现有问题
MDX 驱动
使用 JSX 及 React 撰写交互组件并嵌入 Markdown 文本
搜索 - 全站均可被搜索
文档分版 - 帮助您的项目发行及文档保持同步
i18n - 将您的网站翻译至多国语言

应用案例

📱 React Native，作为一个广受欢迎的移动应用开发框架，其官方文档使用 Docusaurus 构建，提供了关于如何使用 React Native 的详细信息和教程。
🔧 Babel，作为一个广泛使用的 JavaScript 编译器，其官方文档也是用 Docusaurus 开发的，为开发者提供了关于 Babel 的详尽信息。

官网上有很多经典的应用，并且很重要的是，这样的个人网站，或者开发在线文档都提供了源码。 Docusaurus Site Showcase | Docusaurus

我的使用体验

最近我开始使用Docusaurus搭建www.codedriver.com.cn 文档网站。核心诉求就是快速、美观、全文搜索。这三个诉求都比较容易搜索，接下来的步骤就是找模版： Docusaurus - 快速构建高效的网站，专注处理内容 | Docusaurus中文文档 | Docusaurus中文网