Skip to main content

CLI

Docusaurusは、ウェブサイトの生成、配信、デプロイを支援するスクリプト一式を提供します。

ウェブサイトが初期設定されると、ウェブサイトのソースにDocusaurusスクリプトが含まれ、パッケージマネージャで起動できるようになります。

package.json
{
  // ...
  "scripts": {
    "docusaurus": "docusaurus",
    "start": "docusaurus start",
    "build": "docusaurus build",
    "swizzle": "docusaurus swizzle",
    "deploy": "docusaurus deploy",
    "clear": "docusaurus clear",
    "serve": "docusaurus serve",
    "write-translations": "docusaurus write-translations",
    "write-heading-ids": "docusaurus write-heading-ids"
  }
}

Docusaurus CLIコマンド​

以下は、DocusaurusのCLIコマンドとその使い方の一覧です。

docusaurus start [siteDir]​

Webpack Dev Serverを使ってローカル上でサイトのプレビューをビルド及び配信します。

Options​

名前Default説明
--port3000開発サーバのポート番号を指定します。
--hostlocalhost使用するホスト名を指定します。 例えば、サーバに外部からアクセスできるようにしたい場合は、 --host 0.0.0.0と指定できます。
--localeSpecify site locale to be used.
--hot-onlyfalseビルドに失敗した場合のフォールバックとして、ページ更新なしでのホットモジュールリプレースメントを有効にします。 詳細はこちらを参照。
--no-openfalseブラウザでページを自動的に開かないようにします。
--configundefinedDocusaurus設定ファイルへのパスです。初期値は[siteDir]/docusaurus.config.jsです。
--poll [optionalIntervalMs]false監視が機能しない環境では、ライブ・リロードの監視ではなく、ファイルのポーリングをフォールバックとして使用します。 詳細はこちらを参照。
--no-minifyfalseJS/CSSバンドルを最小化せずにウェブサイトをビルドします。
情報

一部の機能（アンカーリンクなど）は開発段階では動作しませんのでご注意ください。 本機能は本番環境では期待通りに動作します。

ネットワーク越しでの開発

リモートサーバーやVM（GitHub Codespacesなど）から3000番ポートを転送する場合は、0.0.0.0で開発サーバーを実行し、ローカルIPでリッスンするようにします。

npm run start -- --host 0.0.0.0

HTTPSの有効化​

証明書を取得する方法は複数あります。 ここでは例としてmkcertを使用します。

  1. mkcert localhostを実行してlocalhost.pem・localhost-key.pemを生成

  2. mkcert -installを実行して、トラストストアに証明書をインストールし、ブラウザを再起動

  3. 次のように、Docusaurus HTTPS環境変数を指定してアプリを起動：

HTTPS=true SSL_CRT_FILE=localhost.pem SSL_KEY_FILE=localhost-key.pem yarn start
  1. https://localhost:3000/を開く

docusaurus build [siteDir]​

サイトを本番用にコンパイルします。

Options​

名前Default説明
--devBuilds the website in dev mode, including full React error messages.
--bundle-analyzerfalseWebpack Bundle Analyzerでバンドルを分析します。
--out-dirbuild現在のワークスペースからの相対パスで、新しい出力ディレクトリのフルパスです。
--configundefinedDocusaurus設定ファイルへのパスです。初期値は[siteDir]/docusaurus.config.jsです。
--localeBuild the site in the specified locale(s). If not specified, all known locales are built.
--no-minifyfalseJS/CSSバンドルを最小化せずにウェブサイトをビルドします。
情報

CSSバンドルの高度な最小化のために、私たちは（追加のいくつかのPostCSSプラグインと一緒に）高度なcssnanoプリセットとclean-cssのレベル2の最適化を使用しています。 この高度なCSS最小化の結果、CSSに不具合が出た場合は、環境変数USE_SIMPLE_CSS_MINIFIER=trueを設定してウェブサイトをビルドし、デフォルトのcssnanoプリセットでCSSを最小化してください。 CSS最小化のバグに遭遇した場合は、issueを立ててください。

環境変数SKIP_HTML_MINIFICATION=trueでHTMLの縮小をスキップできます。

docusaurus swizzle [themeName] [componentName] [siteDir]​

テーマコンポーネントをスウィズリングしてカスタマイズします。

npm run swizzle [themeName] [componentName] [siteDir]

# 例（現在のディレクトリであることを示すためsiteDirは省略）
npm run swizzle @docusaurus/theme-classic Footer -- --eject

スウィズルCLIは対話式で、スウィズリングのプロセス全体を案内します。

Options​

名前説明
themeNameスウィズリング元のテーマ名
componentNameスウィズリング対象のテーマコンポーネント名
--listスウィズリング可能なコンポーネントを一覧表示
--ejectEject the theme component
--wrapWrap the theme component
--dangerAllow immediate swizzling of unsafe components
--typescriptSwizzle the TypeScript variant component
--configPath to docusaurus config file, default to [siteDir]/docusaurus.config.js
警告

安全でないコンポーネントは、内部のリファクタリングによって破壊的変更の影響に晒される危険性が高いです。

docusaurus deploy [siteDir]​

Deploys your site with GitHub Pages. Check out the docs on deployment for more details.

Options​

名前Default説明
--localeDeploy the site in the specified locale(s). If not specified, all known locales are deployed.
--out-dirbuild現在のワークスペースからの相対パスで、新しい出力ディレクトリのフルパスです。
--skip-buildfalseDeploy website without building it. This may be useful when using a custom deploy script.
--target-dir.Path to the target directory to deploy to.
--configundefinedDocusaurus設定ファイルへのパスです。初期値は[siteDir]/docusaurus.config.jsです。

docusaurus serve [siteDir]​

Serve your built website locally.

名前Default説明
--port3000Use specified port
--dirbuildThe full path for the output directory, relative to the current workspace
--buildfalseBuild website before serving
--configundefinedDocusaurus設定ファイルへのパスです。初期値は[siteDir]/docusaurus.config.jsです。
--hostlocalhost使用するホスト名を指定します。 例えば、サーバに外部からアクセスできるようにしたい場合は、 --host 0.0.0.0と指定できます。
--no-openfalse locally, true in CIDo not open a browser window to the server location.

docusaurus clear [siteDir]​

Clear a Docusaurus site's generated assets, caches, build artifacts.

We recommend running this command before reporting bugs, after upgrading versions, or anytime you have issues with your Docusaurus site.

docusaurus write-translations [siteDir]​

Write the JSON translation files that you will have to translate.

By default, the files are written in website/i18n/<defaultLocale>/....

名前Default説明
--locale<defaultLocale>Define which locale folder you want to write translations the JSON files in
--overridefalseOverride existing translation messages
--configundefinedDocusaurus設定ファイルへのパスです。初期値は[siteDir]/docusaurus.config.jsです。
--messagePrefix''Allows adding a prefix to each translation message, to help you highlight untranslated strings

docusaurus write-heading-ids [siteDir] [files]​

Add explicit heading IDs to the Markdown documents of your site.

名前Default説明
filesAll MD files used by pluginsThe files that you want heading IDs to be written to.
--maintain-casefalseKeep the headings' casing, otherwise make all lowercase.
--overwritefalseOverwrite existing heading IDs.