Docusaurus 是 Faecbook 专门为开源项目开发者提供的一款易于维护的静态网站创建工具,使用 Markdown 即可更新网站。使用「Docusaurus」构建一个带有主页、文档、API、帮助 以及博客页面的静态网站几分钟即可搞定,不过前提是你需要有一个环境空间,支持NPM,在服务器上部署好环境后,即可通过官方介绍的安装步骤进行安装。
一、首先创建一个项目根目录。就是你要放Docusaurus的一个文件夹。
我这个文件的地址就是:F:\Docusaurus(你可以按你自己的习惯来)
二、配置node.js环境
1、下载node.js安装程序
node.js官网:https://nodejs.org/zh-cn/
可以选择下载最新的版本,下载的是msi文件,按照安装向导安装即可。
2、检测node.js环境
打开windows的运行程序,输入cmd打开命令框,在命令框中输入 node -v 命令检测node.js的版本。
如果出现了版本号则表示node.js已成功安装。
三、使用npm命令安装docusaurus
1、打开Windows的命令框,打开到刚才创建的Docusaurus路径,运行npm install --global docusaurus-init 命令
2、看你自己电脑上的安装路径,然后找到文件:docusaurus-init
3、把盘符切换到:F:\Docusaurus 运行npx docusaurus-init 命令
生成的文件如下
重命名docs-examples-from-docusaurus为docs.
重命名website文件下的blog-examples-from-docusaurus为blog。
四、通过本地服务器运行
打开项目路径里的website目录,运行npm start 命令
最后生成的网页是这样的
教程到此结束。
最后分享一个托管于Github上的一个中文版的官方文档
[Docusaurus](https://github.com/demopark/docusaurus-docs-Zh_CN)
领取专属 10元无门槛券
私享最新 技术干货