Skip to content

chore: doc included-files in README #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2021
Merged

chore: doc included-files in README #325

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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?**
Expand Down