30秒でdocusaurusを立ち上げて、ドキュメントサイトを作成する方法

docusaurus 30sec setup npm yurupro JavaScript
この記事は約2分で読めます。

この記事の最終更新日: 2023年2月2日

Docusaurusは、静的Webサイト作成フレームワークです。使い方は以下の手順で行います:

  1. Docusaurusのインストール:Node.jsとnpmがインストールされていることが前提です。ターミナルから、「npm install -g docusaurus-init」と入力してインストールします。
  2. ‘$ mkdir docusaurus-your-porject’ ‘$ cd docusaurus-your-porject’で、作業プロジェクトディレクトリに入ります。
  3. プロジェクトの作成:「docusaurus-init」コマンドを使用すると、セットアップが開始されます(「docusaurus-init my-project」と入力すると、「my-project」という名前の新しいプロジェクトが作成されます。)
  4. サイトの設定:「my-project」ディレクトリ内に移動し、「siteConfig.js」ファイルを編集してサイトのタイトルや説明、ソーシャルリンクなどを設定します。
  5. コンテンツの作成:「docs」ディレクトリ内にMarkdown形式のドキュメントを作成します。
  6. サイトのビルド:package.jsonが存在するディレクトリ、今回でいう「website」ディレクトリで、「npm run start」コマンドを使用して、サイトをビルドしてローカルサーバーを起動します。ブラウザで「http://localhost:3000」にアクセスすると、作成したサイトが表示されます。

これらの手順を行えば、簡単にDocusaurusを使って静的Webサイトを作成することができます。

コメント

タイトルとURLをコピーしました