Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity

docs: add next.js docs (#3002)

Browse Source 
## What

This change adds the next.js sdk's readme to the client-side SDKs
section in the docs.

## Why

Because we have a new and official SDK 🙌🏼
This commit is contained in:
Thomas Heartman 2023-01-27 08:33:19 +01:00 committed by GitHub
parent d8a250dc9c
commit f1984080a9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
website/readme-fns.js
View File

@ -14,8 +14,8 @@
//
// type ReadmeData = Readme & { repoUrl: string };
const CLIENT_SIDE_SDK = "client-side"
const SERVER_SIDE_SDK = "server-side"
const CLIENT_SIDE_SDK = 'client-side';
const SERVER_SIDE_SDK = 'server-side';
const serverSideSdks = {
'unleash-client-go': {
@ -71,6 +71,10 @@ const clientSideSdks = {
'proxy-client-vue': {
sidebarName: 'Vue',
},
'unleash-client-nextjs': {
sidebarName: 'Next.js',
slugName: 'next-js',
},
};
const allSdks = () => {
@ -158,16 +162,14 @@ const modifyContent = (filename, content) => {
const getConnectionTip = (sdkType) => {
switch (sdkType) {
case CLIENT_SIDE_SDK: return `To connect this SDK to Unleash, you'll need to use either
- the [Unleash front-end API](/reference/front-end-api) (released in Unleash 4.16) ([how do I create an API token?](/how-to/how-to-create-api-tokens.mdx))
- the [Unleash proxy](/reference/unleash-proxy) ([how do I create client keys?](/reference/api-tokens-and-client-keys#proxy-client-keys))
This SDK **cannot** connect to the regular (server-side) \`client\` API.`
case CLIENT_SIDE_SDK:
return `To connect to Unleash from a client-side context, you'll need to use the [Unleash front-end API](/reference/front-end-api) ([how do I create an API token?](/how-to/how-to-create-api-tokens.mdx)) or the [Unleash proxy](/reference/unleash-proxy) ([how do I create client keys?](/reference/api-tokens-and-client-keys#proxy-client-keys)).`;
case SERVER_SIDE_SDK:
default: return `To connect to Unleash, you'll need your Unleash API url (e.g. \`https://<your-unleash>/api\`) and a [server-side API token](/reference/api-tokens-and-client-keys.mdx#client-tokens) ([how do I create an API token?](/how-to/how-to-create-api-tokens.mdx)).`
}
default:
return `To connect to Unleash, you'll need your Unleash API url (e.g. \`https://<your-unleash>/api\`) and a [server-side API token](/reference/api-tokens-and-client-keys.mdx#client-tokens) ([how do I create an API token?](/how-to/how-to-create-api-tokens.mdx)).`;
}
};
return {
filename: `${sdk.type}/${sdk.slugName}.md`,