Skip to content

Commit

Permalink
chore(gatsby-plugin-create-client-paths): Update client paths plugin …
Browse files Browse the repository at this point in the history
…readme with migration info (#34423)
  • Loading branch information
tyhopp authored Jan 7, 2022
1 parent 5489ef9 commit dda1a26
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion packages/gatsby-plugin-create-client-paths/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,24 @@
# gatsby-plugin-create-client-paths

**Please Note:** With recent versions of Gatsby this plugin became obsolete. You should use the [File System Route API](https://www.gatsbyjs.com/docs/reference/routing/file-system-route-api/#creating-client-only-routes) to create client-only paths.
**Please Note:** With recent versions of Gatsby this plugin became obsolete. See [migration](#migration) notes below, or refer to the [File System Route API](https://www.gatsbyjs.com/docs/reference/routing/file-system-route-api/#creating-client-only-routes) documentation for details on how client only routes are now handled.

Use this plugin to simplify creating a “hybrid” Gatsby app with both statically rendered pages as well as "client-paths". These paths exist on the client only and do not correspond to index.html files in an app's built assets.

For more information refer to [client-only routes & user authentication](https://www.gatsbyjs.org/docs/client-only-routes-and-user-authentication/).

## Migration

Extending from the use case below where the `gatsby-plugin-create-client-paths` plugin has a prefix of `/app/*`, the way you would do this with the [File System Route API](https://www.gatsbyjs.com/docs/reference/routing/file-system-route-api/#creating-client-only-routes) is by adopting this structure in your project:

```text
|-- /src
|-- /pages
|-- /app
|-- [...].js
```

Additionally, you can also refer to the [client-only-paths](https://github.com/gatsbyjs/gatsby/tree/master/examples/client-only-paths) example.

## Usage

Install:
Expand Down

0 comments on commit dda1a26

Please sign in to comment.