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

チュートリアル入門

5分未満でDocusaurusを発見しましょう。

始め方

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

または、docusaurus.newすぐにDocusaurusを試すこともできます。

必要なもの

  • 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(このページ)を開いていくつかの行を編集してください:サイトは自動的にリロードされ、変更が表示されます。