项目简介
本项目是基于Docusaurus 2框架构建的现代化静态网站生成器。Docusaurus 2具备强大的文档和页面生成能力,可用于构建各类网站,如公司官网、产品文档等。项目提供了从安装、本地开发、构建到部署的完整网站构建流程。
项目的主要特性和功能
- 静态网站生成:借助Docusaurus 2框架生成静态HTML页面,能适应各种网络环境。
- 丰富的文档功能:支持多种文档展示形式,如API文档、用户指南等。
- 本地开发便捷:提供本地开发服务器,可实时预览修改内容。
安装使用步骤
安装依赖
下载源码后,在终端运行以下命令安装依赖:
bash
$ yarn
本地开发
运行以下命令启动本地开发服务器:
bash
$ yarn start
此时会启动一个本地开发服务器,并在浏览器中打开网站。大部分修改都会实时反映,无需重启服务器。
构建网站
运行以下命令生成静态内容:
bash
$ yarn build
生成的静态内容会存放在build
目录中,可以使用任何静态内容托管服务进行部署。
部署网站
使用SSH部署:
bash
$ USE_SSH=true yarn deploy
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】