5分钟搭建网站或帮助文档神器Docusaurus

发布日期： 2024-10-19 阅读量： 作者： yebuyugz9B

Docusaurus是一个由Facebook开源免费的静态网站生成器，它专为构建易于维护和部署的文档网站而设计。只要你掌握markdown用法，就能够结合Docusaurus快速完成静态网站或者帮助手册的搭建。

5分钟搭建网站或帮助文档神器Docusaurus(图1)

文档介绍：https://www.docusaurus.cn/TXAPP.TV

以下是对Docusaurus的详细介绍：

5分钟搭建网站或帮助文档神器Docusaurus(图2)

基于React：Docusaurus使用React作为主要的前端框架，结合了Webpack、Babel等流行的JavaScript库和工具，提供了现代化的前端技术栈支持。
Markdown支持：Docusaurus支持使用Markdown编写文档，简化了文档内容的编写和组织过程。
内置文档功能：Docusaurus提供了内置的Markdown编辑器和文档结构，支持多语言文档和版本控制，方便文档的维护和更新。
自定义主题：Docusaurus允许开发者自定义整个文档网站的主题，包括颜色、布局、字体等，使文档网站更加个性化。
响应式布局：Docusaurus自动生成的网站具有响应式布局，可以在不同设备上自适应显示，提升用户体验。
快速构建和部署：Docusaurus使用现代化的前端技术构建，具有快速的编译和加载速度。同时，Docusaurus还提供了内置的部署工具，可以轻松地将文档网站部署到各种托管平台上。

Docusaurus不仅适用于构建开发文档、技术文档、产品文档等类型的文档网站，还可以用于创建各种类型的网站，如个人网站、产品展示、博客、营销登录页面等。

环境要求：Node.js 环境要求：Node.js 18.0 或更高版本

npm install docusaurus

然后用以下命令完成网站目录的创建：

npx create-docusaurus@latest my-website classic

执行完成后会在当前目录下面生成网站初始目录：

然后就可以用npm命令启动该工程了：

npm start

访问地址： http://localhost:3000/

到此为止，项目的框架就搭建好了，但是目前咱们看到的还是一些示例数据和样式，接下来就需要去配置这个网站的一些基本信息了，比如顶部导航栏有哪些菜单、正文有哪些板块和数据、页脚有哪些外部链接。

主要就是修改docusaurus.config.ts（主配置文件）和sidebars.ts（侧边栏配置）

网站的菜单和主体完毕后，最后就是编写md文件了，配置好了放到对应的目录：

md文件最后要与sidebars.ts中的items对应上，这样的话网站上面菜单点击的时候右侧内容页就会去加载显示对应的md文件了。这样的话一个简单的网站就搭建好了，它包含首页和基本的导航帮助页。

总之，Docusaurus是一个功能强大且易于使用的静态网站生成器，适用于构建各种类型的文档网站和其他类型的网站。糖心vlog

糖心糖心vlog TXAPP.TV

随便看看