Docusaurus是一个由开源免费的静态网站生成器,它专为构建易于维护和部署的文档网站而设计。只要你掌握markdown用法,就能够结合Docusaurus快速完成静态网站或者帮助手册的搭建。
文档介绍:
以下是对Docusaurus的详细介绍:
一、技术特点
二、应用场景
Docusaurus不仅适用于构建开发文档、技术文档、产品文档等类型的文档网站,还可以用于创建各种类型的网站,如个人网站、产品展示、博客、营销登录页面等。
三、使用方式
- 初始化项目:安装Docusaurus并创建新项目,可以选择使用Docusaurus CLI在本地搭建项目,也可以借助云开发平台进行一键部署。
- 编写文档:在项目中编写Markdown格式的文档,并通过文件组织结构来管理和展示文档内容。
- 配置网站:通过修改
docusaurus.config.js等配置文件来定制网站的导航栏、侧边栏、国际化选项等。 - 构建和部署:使用Docusaurus提供的命令行工具构建静态网站,并将构建结果部署到指定的托管平台上。
四、优势
- 简单易用:Docusaurus简化了文档网站的搭建过程,提供了易于使用的命令行工具和预设的模板。
- 功能强大:Docusaurus提供了丰富的功能,如内置文档功能、自定义主题、响应式布局等,满足各种文档网站的需求。
- 社区支持:Docusaurus是一个开源项目,拥有活跃的社区和丰富的文档资源,方便开发者获取帮助和解决问题。
五、用法
环境要求:Node.js 18.0 或更高版本
npm install docusaurus
npx create-docusaurus@latest my-website classic
然后就可以用npm命令启动该工程了:
npm start
到此为止,项目的框架就搭建好了,但是目前咱们看到的还是一些示例数据和样式,接下来就需要去配置这个网站的一些基本信息了,比如顶部导航栏有哪些菜单、正文有哪些板块和数据、页脚有哪些外部链接。
主要就是修改docusaurus.config.ts(主配置文件)和sidebars.ts(侧边栏配置)
md文件最后要与sidebars.ts中的items对应上,这样的话网站上面菜单点击的时候右侧内容页就会去加载显示对应的md文件了。这样的话一个简单的网站就搭建好了,它包含首页和基本的导航帮助页。
总之,Docusaurus是一个功能强大且易于使用的静态网站生成器,适用于构建各种类型的文档网站和其他类型的网站。