Aller au contenu principal

Prerequisites

Before creating a Docusaurus docs site, make sure your machine is ready.

Required Software​

  • Node.js 18 or later (LTS recommended)
  • npm (comes with Node) or yarn
  • Git
  • A code editor such as VS Code

Verify Installation​

Run:

node -v
npm -v
git --version

If commands are not found, install the missing tool first.

  • Basic Markdown syntax
  • Basic terminal commands
  • Basic Git workflow (clone, commit, push)

Network and Access​

If your company uses a proxy or restricted network:

  • Configure npm registry and proxy
  • Ensure package download access to npm
  • Ensure deployment target (GitHub/Netlify/Vercel) is reachable

Planning Before You Start​

Define:

  • Documentation sections (getting started, guides, references)
  • Audience (developers, users, internal team)
  • Versioning strategy
  • Language requirements (single language or i18n)