Skip to Content
比較の観点docs ディレクトリの配置自由度

docs ディレクトリの配置自由度

配置の自由度

コンテンツの配置場所と、公開URLのベースパスは、互いに独立して設定できる。 next.config.mjs の nextra() ラッパーで指定する contentDirBasePath オプションは、content/ ディレクトリ配下のファイルがどのパス接頭辞で配信 されるかを制御するものであり、そのディレクトリがリポジトリ上のどこに物理的に 存在するかとは無関係である。本プロジェクトは contentDirBasePath: '/' (Nextra の既定値でもある)を設定しているため、ページはサイトルートから 配信されているが、同じコンテンツツリーを /docs のようなカスタム接頭辞の下に マウントすることも、ファイルを1つも移動せずに可能である。つまり content/ フォルダの深さや配置場所は、公開URLの構造と一致させる必要はない。

index.md は README.md で代替できるか

できない。これは本プロジェクトで実証済みの事実である。Nextra はファイルの basename(拡張子を除いたファイル名)からルートを導出し、文字通り index という名前のファイル(index.md/index.mdx)のみを、そのフォルダの ルートページとして扱う。同じフォルダに README.md を置いても、それが フォルダのインデックスになることはない。代わりに、ファイル名を保持した 通常のページとして配信され(例: .../README でアクセス可能)、index という名前のファイルが存在しないため、フォルダのルートURL自体は404になる。 これは、README.md をそのままフォルダのインデックスページとして使える Docusaurus との明確な違いである。

Last updated on