メインコンテンツまでスキップ

チュートリアル紹介

5 分以内で Docusaurus を学びましょう

はじめに

新しいサイトを作成して 始めましょう。

または docusaurus.newDocusaurus をすぐに試してみる こともできます。

必要なもの

  • Node.js バージョン 18.0 以上:
    • Node.js をインストールする際は、依存関係に関連するすべてのチェックボックスにチェックを入れることをおすすめします。

新しいサイトの生成

クラシックテンプレートを使用して新しい Docusaurus サイトを生成します。

以下のコマンドを実行すると、クラシックテンプレートが自動的にプロジェクトに追加されます:

npm init docusaurus@latest my-website classic

このコマンドは、コマンドプロンプト、Powershell、ターミナル、またはコードエディタの統合ターミナルなどで入力できます。

このコマンドは、Docusaurus を実行するために必要なすべての依存関係もインストールします。

サイトを起動する

開発サーバーを実行します:

cd my-website
npm run start

cd コマンドは、作業するディレクトリを変更します。新しく作成した Docusaurus サイトで作業するには、ターミナルでそのディレクトリに移動する必要があります。

npm run start コマンドは、ローカルでウェブサイトをビルドし、開発サーバーを通じて提供します。http://localhost:3000/ で閲覧できる状態になります。

docs/intro.md(このページ)を開いて数行を編集してみてください。サイトは自動的にリロードされ、変更が表示されます。