Troubleshooting

This article outlines about mitigating common configuration issues and upgrades

Initialization

The project requires Node.js version 18 or up and uses npm as the package manager.

npx create-docusaurus@latest website classic --typescript

npm

npm run start

Yarn

yarn run start

pnpm

pnpm run start

Bun

bun run start

Test locally

npm

npm run build && npm run serve

Yarn

yarn build&& yarn serve

pnpm

pnpm run build&& pnpm run serve

Bun

bun run build&& bun run serve

Fix Common Issues

Issues can happen especially during upgrades in the core packages. If you ran into one, follow these steps:

Clear caches

npm

npm run clear

Yarn

yarn clear

pnpm

pnpm run clear

Bun

bun run clear

Delete modules

Delete the node_modules and package-lock.json, or yarn.lock

Bash

rm -rf node_modules yarn.lock package-lock.json

PowerShell

@('node_modules','yarn.lock','package-lock.json') | Remove-Item -Force -Recurse -ErrorAction SilentlyContinue

Reinstall packages

For Yarn

Skip this if you're not using yarn.

Bash

ni yarn.lock

CMD

echo. > yarn.lock

PowerShell

New-Item yarn.lock -ItemType File

npm

npm install

Yarn

yarn install

pnpm

pnpm install

Bun

bun install

Using Yarn

important

Installing Yarn globally is NOT recommended.

Instead, we can use Corepack, which enables us to define our preferred package manager and its version in the package.json file.

corepack enable

yarn set version stable

yarn install

yarn start