basePath

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

basePath は、アプリケーションのパスプレフィックスを設定できるようにします。たとえば、デフォルトの '' (空文字列) の代わりに /docs を使用するには、next.config.js を開き、basePath 設定を追加します。

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

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

リンク

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

たとえば、/about を使用すると、basePath が /docs に設定されている場合、自動的に /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 を追加する必要があります。

たとえば、/docs に basePath を設定している場合、/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