Docusaurus - プロジェクトを起動する

公開日 :

前回の記事で、1つプロジェクトを作成しましたので、カスタマイズをするにあたって必要となる手順をすすめていきます。

ディレクトリ構造を確認する

コマンドを利用してプロジェクトを作成したあとのディレクトリ構成は、以下のようになっています。

random desc

ローカルで実行する

ファイルが配置された段階で、以下のコマンドを実行します。

yarn start

しばらくすると、Node.js のインスタンスが起動してブラウザの画面にページが表示されます。

random desc

ファイルの中身を変更する

上記のようにコマンドを実行して、ブラウザでページを表示したままコードを書き換えてみましょう。まず、メニューの Docs を選択して、Style Guide のページに移動します。

random desc

続いて、docs フォルダにある doc1.md を開いてください。

random desc

ここで、ページのタイトル、およびサイドメニューのタイトルを変更します。doc1.md のファイルの最初の定義は以下のようになっています。

---
id: doc1
title: Style Guide
sidebar_label: Style Guide
slug: /
---

これを以下のように書き換えて

---
id: doc1
title: スタイルガイド
sidebar_label: スタイルガイド
slug: /
---

保存をすると、ブラウザの表示が変わることがわかります。

random desc

Visual Studio Code の markdown のプレビュー機能を利用しながらページを作成していくのも非常に便利ですが、合わせてサイトの仕上がりに関してローカルで確認することができます。ファイルを保存したタイミングで、新しいデータを読み込んで表示する形になります。