gatsby-plugin-netlify-cache

KO | EN

gitlite — search

#llm #android #machine-learning #rust #linux #docker #macos #awesome #kubernetes #vue #awesome-list #security #mcp #ios

gatsby-plugin-netlify-cache

(★ 119)

Caches your Gatsby .cache and public folder to speed up your build time by 10x

gatsby-plugin-netlify-cache Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# THIS PLUGIN IS DEPRECATED

In favor of https://github.com/netlify/netlify-plugin-gatsby, this plugin will get no more new releases.

---

## gatsby-plugin-netlify-cache (DEPRECATED)

> This plugin caches your build files locally or in the Netlify cache directory. It will massively speed up subsequent builds.

## ☁️ Installation

```sh
npm install gatsby-plugin-netlify-cache
```

## 🛫 Setup

Add `'gatsby-plugin-netlify-cache'` to the plugins in your `gatsby-config.js` file.

## ✋ Usage

### Locally

In your local environment nothing happens to avoid conflicts with your development process. It actually checks if `process.env.NETLIFY_BUILD_BASE` exists to detect a Netlify environment.

### Netlify

It automatically restores your cache and caches new files within the Netlify cache folder. This folder is [undocumented but works fine](https://www.contentful.com/blog/2018/05/17/faster-static-site-builds-part-one-process-only-what-you-need/#caching-for-the-win). To reset the cache, hit the `Clear build cache` checkbox in the Netlify app.

These folders are cached by default:

* `.cache` directory

## ⚙️ Configuration

### `cachePublic` - default: `false`

The Public directory used to be cached by default.

It was disabled by default as over time, caching the Public directory can result in a huge directory size which can break your Netlify build.

Enable this option with caution.

```js
plugins: [
  {
    resolve: "gatsby-plugin-netlify-cache",
    options: {
      cachePublic: true
    }
  }
]
```

### `extraDirsToCache` - default: `[]`

If you need additional directories to be cached, you can use the option `extraDirsToCache` to include one or multiple directories in the Netlify cache:

```js
plugins: [
  {
    resolve: "gatsby-plugin-netlify-cache",
    options: {
      extraDirsToCache: [
        "extraDir",
        ".extraDotDir",
        "extra/dir"
      ]
    }
  }
]
```

> Note: the directory path is relative to the project root directory

gatsby-plugin-netlify-cache

gatsby-plugin-netlify-cache Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

gatsby-plugin-netlify-cache

gatsby-plugin-netlify-cache Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README