跳到主要内容

介绍

Docusaurus 是一个开源的静态网站生成器，专注于帮助开发者快速构建、部署和维护文档类网站。

官网：https://docusaurus.io/zh-CN/

优点​

  • 高度自定义：
    • 使用 react 开发，并支持自定义扩展组件或自定义页面
    • 提供 swizzle 命令可完全自定义布局
  • 基础页面干净整洁，可快速捕捉到关键信息
  • 社区群庞大，拥有广大的社区支持
  • 同时支持 docs（文档） 和 blog（博客），能够有更多的选择

快速开始​

1.环境要求​

  • Node版本最低 20

2.安装​

npx create-docusaurus@latest my-website classic

如果需要支持 typescript，则使用

npx create-docusaurus@latest my-website classic --typescript

3.运行​

下载依赖

pnpm i

运行项目

pnpm run start