From a59853b70bf3448b291d648b7b146dc7e0a6facc Mon Sep 17 00:00:00 2001 From: Lindsay Levine Date: Tue, 18 May 2021 22:30:51 -0400 Subject: [PATCH] chore: doc included-files in README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 9f917aa5a5..6770a8bb7c 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ This build plugin is a utility for supporting Next.js on Netlify. To enable serv - [Custom Netlify Functions](#custom-netlify-functions) - [Publish Directory](#publish-directory) - [Custom Netlify Redirects](#custom-netlify-redirects) +- [Local Files in Runtime](#local-files-in-runtime) - [FAQ](#faq) - [Caveats](#caveats) - [Credits](#credits) @@ -135,6 +136,23 @@ The precedence of these rules are: Read more about [Netlify redirects](https://docs.netlify.com/routing/redirects/) in our docs. +## Local Files in Runtime + +A common requirement for Next.js projects is to require local files in Next.js pages (see [markdown issue](https://github.com/netlify/netlify-plugin-nextjs/issues/153) and [i18next issue](https://github.com/netlify/netlify-plugin-nextjs/issues/223) as examples). + +In this case, you can configure your netlify.toml to make sure these files are included in the function runtime environment. This is necessary for pages that use fallback: true, SSR, preview mode, etc. For example: + +```toml +[build] + command = "npm run build" + +[functions] + # Includes all Markdown files inside the "files/" directory. + included_files = ["files/*.md"] +``` + +Read more about functions configuration and `included_files` in our [docs](https://docs.netlify.com/configure-builds/file-based-configuration/#functions). + ## FAQ **Q: What can I do if my builds fail suddenly from a broken plugin release or plugin dependency?**