updated documentation

jetbridge · Oct 23, 2023 · 7888320 · 7888320
1 parent aae4c9d
commit 7888320
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/src/Nextjs.ts b/src/Nextjs.ts
@@ -59,6 +59,10 @@ export interface NextjsProps extends NextjsBaseProps {
   /**
    * Optional value to prefix the Next.js site under a /prefix path on CloudFront.
    * Usually used when you deploy multiple Next.js sites on same domain using /sub-path
+   *
+   * Note, you'll need to set [basePath](https://nextjs.org/docs/app/api-reference/next-config-js/basePath)
+   * in your `next.config.ts` to this value and ensure any files in `public`
+   * folder have correct prefix.
    * @example "/my-base-path"
    */
   readonly basePath?: string;

diff --git a/src/NextjsDistribution.ts b/src/NextjsDistribution.ts
@@ -129,6 +129,11 @@ export interface NextjsDistributionProps extends NextjsBaseProps {
   /**
    * Optional value to prefix the Next.js site under a /prefix path on CloudFront.
    * Usually used when you deploy multiple Next.js sites on same domain using /sub-path
+   *
+   * Note, you'll need to set [basePath](https://nextjs.org/docs/app/api-reference/next-config-js/basePath)
+   * in your `next.config.ts` to this value and ensure any files in `public`
+   * folder have correct prefix.
+   * @example "/my-base-path"
    */
   readonly basePath?: string;
 

diff --git a/src/NextjsStaticAssets.ts b/src/NextjsStaticAssets.ts
@@ -25,6 +25,11 @@ export interface NextjsStaticAssetsProps {
   /**
    * Optional value to prefix the Next.js site under a /prefix path on CloudFront.
    * Usually used when you deploy multiple Next.js sites on same domain using /sub-path
+   *
+   * Note, you'll need to set [basePath](https://nextjs.org/docs/app/api-reference/next-config-js/basePath)
+   * in your `next.config.ts` to this value and ensure any files in `public`
+   * folder have correct prefix.
+   * @example "/my-base-path"
    */
   readonly basePath?: string;
 }