Skip to content

Commit 890af83

Browse files
chore: doc included-files in README (#325)
1 parent fa8bb50 commit 890af83

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ This build plugin is a utility for supporting Next.js on Netlify. To enable serv
2020
- [Custom Netlify Functions](#custom-netlify-functions)
2121
- [Publish Directory](#publish-directory)
2222
- [Custom Netlify Redirects](#custom-netlify-redirects)
23+
- [Local Files in Runtime](#local-files-in-runtime)
2324
- [FAQ](#faq)
2425
- [Caveats](#caveats)
2526
- [Credits](#credits)
@@ -135,6 +136,23 @@ The precedence of these rules are:
135136

136137
Read more about [Netlify redirects](https://docs.netlify.com/routing/redirects/) in our docs.
137138

139+
## Local Files in Runtime
140+
141+
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).
142+
143+
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:
144+
145+
```toml
146+
[build]
147+
command = "npm run build"
148+
149+
[functions]
150+
# Includes all Markdown files inside the "files/" directory.
151+
included_files = ["files/*.md"]
152+
```
153+
154+
Read more about functions configuration and `included_files` in our [docs](https://docs.netlify.com/configure-builds/file-based-configuration/#functions).
155+
138156
## FAQ
139157

140158
**Q: What can I do if my builds fail suddenly from a broken plugin release or plugin dependency?**

0 commit comments

Comments
 (0)