basePath

Next.jsアプリケーションをドメインのサブパスにデプロイするには、basePath設定オプションを使用できます。

basePathを使用すると、アプリケーションのパスプレフィックスを設定できます。例えば、デフォルトの''（空の文字列）ではなく/docsを使用するには、next.config.jsを開いてbasePath設定を追加します。

module.exports = {
  basePath: '/docs',
}

注意: この値はビルド時に設定する必要があり、クライアントサイドのバンドルにインライン化されるため、再ビルドなしで変更することはできません。

リンク

next/linkおよびnext/routerを使用して他のページにリンクする場合、basePathは自動的に適用されます。

例えば、basePathが/docsに設定されている場合、/aboutを使用すると自動的に/docs/aboutになります。

export default function HomePage() {
  return (
    <>
      <Link href="/about">About Page</Link>
    </>
  )
}

出力HTML

<a href="/docs/about">About Page</a>

これにより、basePathの値を変更する際にアプリケーション内のすべてのリンクを変更する必要がなくなります。

画像

next/imageコンポーネントを使用する場合、srcの前にbasePathを追加する必要があります。

例えば、basePathが/docsに設定されている場合、/docs/me.pngを使用すると画像が正しく提供されます。

import Image from 'next/image'
 
function Home() {
  return (
    <>
      <h1>My Homepage</h1>
      <Image
        src="/docs/me.png"
        alt="Picture of the author"
        width={500}
        height={500}
      />
      <p>Welcome to my homepage!</p>
    </>
  )
}
 
export default Home