VSCode如何配置Docusaurus网站生成器开发环境

雨静君_7562

雨静君_7562

2026-05-12

739人浏览

原创

Node.js 版本必须 ≥18.0,否则 npx create-docusaurus@latest 会静默失败:目录创建成功但关键依赖(如 @docusaurus/core)未安装,导致后续 yarn start 报错“Cannot find module”。

vscode如何配置docusaurus网站生成器开发环境

Node.js 版本必须 ≥18.0,create-docusaurus 会静默失败

用 npx create-docusaurus@latest my-site classic 初始化项目时,如果系统里装的是 Node.js 16 或更低版本,命令可能看似执行成功、目录也建了,但 package.json 里关键依赖(比如 @docusaurus/core)压根没装上,后续 yarn start 直接报 Cannot find module '@docusaurus/core'。

验证方式很简单:node -v 输出必须是 v18.x 或 v20.x。CentOS/Ubuntu 上别信系统包管理器默认的 nodejs 包——它常是 14 或 16;老老实实用 Nodesource 官方源:

curl -fsSL https://rpm.nodesource.com/setup_18.x | sudo bash -
sudo yum install -y nodejs npm

Windows 用户直接去 nodejs.org 下载 LTS(当前是 20.x),别用 Microsoft Store 里的版本,那个更新滞后且权限异常多。

VSCode 必须启用 Remote-SSH 才能高效编辑远程 Docusaurus 项目

如果你把 Docusaurus 项目部署在 ECS 或自建服务器上(比如 CentOS 8 Stream),本地用 VSCode 编辑,就别拖文件来回同步了——Remote-SSH 插件才是正解。

  • 先在 VSCode 扩展市场搜 Remote-SSH,装好
  • 按 Ctrl+Shift+P → 输入 Remote-SSH: Connect to Host... → 添加你的服务器地址(如 user@192.168.1.100)
  • 连接后,用 File → Open Folder 直接打开服务器上的 /var/www/my-site 目录
  • 此时所有保存、终端命令(比如 yarn start)都跑在远程,热重载毫秒级响应,不用等 FTP 同步

注意:Xshell/Xftp 配合 VSCode 编辑器设置(比如在 Xftp 中右键“在 VSCode 中编辑”)容易因编码或换行符出问题,不如一步到位用 Remote-SSH。

yarn start 报错 EADDRINUSE?检查端口和 baseUrl 冲突

Docusaurus 默认启动在 http://localhost:3000,但如果你改过 docusaurus.config.js 里的 baseUrl(比如设成 /docs/),又没配好本地开发服务器路径,浏览器打开后白屏、控制台报 404,或者 yarn start 直接卡住不动。

常见坑点:

VSCode
VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载
  • baseUrl 必须以 / 开头、结尾不能有斜杠(baseUrl: '/my-blog' ✅,baseUrl: 'my-blog/' ❌)
  • 本地开发时 baseUrl 建议保持默认 /,上线再改;否则要手动加 serve -s build -p 3000 模拟子路径
  • 端口被占?查 lsof -i :3000(macOS/Linux)或 netstat -ano | findstr :3000(Windows),杀掉对应 PID

中文搜索失效?别漏掉 @docusaurus/plugin-client-redirects 和语言配置

很多人照着文档配了 i18n,zh-Hans 文件夹也放进了 i18n/zh-Hans/docusaurus-plugin-content-docs,但搜索框还是只搜英文内容,输入中文没结果。

根本原因:Docusaurus 的中文搜索依赖两个插件协同工作:

  • @docusaurus/plugin-client-redirects:处理路由跳转(尤其多语言下页面路径映射)
  • @docusaurus/theme-search-algolia 或本地 @easyops-cn/docusaurus-search-local(推荐后者,免配 Algolia)

在 docusaurus.config.js 的 plugins 数组里补全:

plugins: [
  [
    '@easyops-cn/docusaurus-search-local',
    {{"indexDocs": true, "indexBlog": false}},
  ],
],

同时确认 i18n 配置中 defaultLocale 和 locales 一致,且 themeConfig 下的 navbar 和 footer 文案已翻译进对应语言 JSON 文件——否则导航栏中文显示正常,但搜索索引仍按英文 key 构建。

最易被忽略的一点:每次改完 i18n 或搜索插件配置,必须删掉 build/ 和 node_modules/.cache 目录再 yarn build,否则旧缓存会让中文搜索持续失效。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

vscode

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3509

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2408

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1340

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1298

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1416

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2318

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3800

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

17735

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程