Skip to content
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

chore(gatsby-plugin-create-client-paths): Update client paths plugin readme with migration info #34423

Merged
merged 1 commit into from
Jan 7, 2022
Merged

chore(gatsby-plugin-create-client-paths): Update client paths plugin readme with migration info #34423

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
15 changes: 14 additions & 1 deletion packages/gatsby-plugin-create-client-paths/README.md
View file
Open in desktop
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