create-zuplo-api 6.57.1 → 6.57.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -14,26 +14,35 @@ category: ""
|
|
|
14
14
|
|
|
15
15
|
Welcome to your new developer portal that makes sense. 🎉
|
|
16
16
|
|
|
17
|
-
This is your new developer portal, built with
|
|
17
|
+
This is your new developer portal, built with
|
|
18
|
+
["Zudoku by Zuplo"](https://github.com/zuplo/zudoku) and designed to elevate
|
|
19
|
+
your API documentation experience. We've streamlined the setup process so you
|
|
20
|
+
can focus on what matters most: creating exceptional developer experiences.
|
|
18
21
|
|
|
19
|
-
Think of this as your API's professional showcase—presenting your endpoints and
|
|
22
|
+
Think of this as your API's professional showcase—presenting your endpoints and
|
|
23
|
+
documentation in the best possible light. Whether you're launching innovative
|
|
24
|
+
new features or improving existing services, this portal provides the foundation
|
|
25
|
+
for clear, accessible, and engaging developer documentation.
|
|
20
26
|
|
|
21
|
-
Let's explore what we've configured for you and how you can customize it to
|
|
27
|
+
Let's explore what we've configured for you and how you can customize it to
|
|
28
|
+
perfectly match your needs.
|
|
22
29
|
|
|
23
30
|
## Let's Review Your Configuration
|
|
24
31
|
|
|
25
|
-
The developer portal is configured in the `zudoku.config.tsx` file. We've
|
|
26
|
-
|
|
32
|
+
The developer portal is configured in the `zudoku.config.tsx` file. We've
|
|
33
|
+
created a starter configuration to get you up and running quickly. Let's walk
|
|
34
|
+
you through everything we've set up so you know how to customize it:
|
|
27
35
|
|
|
28
36
|
<Stepper>
|
|
29
37
|
|
|
30
38
|
1. **Change the Basics**
|
|
31
39
|
|
|
32
|
-
First, you may want to change the title and banner we've put in place. These
|
|
40
|
+
First, you may want to change the title and banner we've put in place. These
|
|
41
|
+
are part of the `page` section in your configuration.
|
|
33
42
|
|
|
34
|
-
:::tip
|
|
35
|
-
|
|
36
|
-
:::
|
|
43
|
+
:::tip **Have a company logo?** Learn how you can
|
|
44
|
+
[add your logo](https://zuplo.com/docs/dev-portal/zudoku/configuration/page#logo)
|
|
45
|
+
in our documentation. :::
|
|
37
46
|
|
|
38
47
|
```jsx
|
|
39
48
|
{
|
|
@@ -55,8 +64,9 @@ Let's walk you through everything we've set up so you know how to customize it:
|
|
|
55
64
|
|
|
56
65
|
1. **API Reference**
|
|
57
66
|
|
|
58
|
-
Your [API Reference](/api) is generated from your Zuplo OpenAPI file in
|
|
59
|
-
|
|
67
|
+
Your [API Reference](/api) is generated from your Zuplo OpenAPI file in
|
|
68
|
+
`../routes.oas.json`—you can add other APIs whenever you need them. Improve
|
|
69
|
+
your documentation by adding more details to the OpenAPI file.
|
|
60
70
|
|
|
61
71
|
```json
|
|
62
72
|
{
|
|
@@ -71,11 +81,14 @@ Let's walk you through everything we've set up so you know how to customize it:
|
|
|
71
81
|
|
|
72
82
|
1. **Authentication & Login**
|
|
73
83
|
|
|
74
|
-
We've configured your project to use [Auth0](https://auth0.com) as an
|
|
84
|
+
We've configured your project to use [Auth0](https://auth0.com) as an
|
|
85
|
+
authentication provider with our demo account. We support many authentication
|
|
86
|
+
providers—check the
|
|
87
|
+
[documentation on how to configure](https://zuplo.com/docs/dev-portal/zudoku/configuration/authentication#authentication-providers)
|
|
88
|
+
each one.
|
|
75
89
|
|
|
76
|
-
:::caution
|
|
77
|
-
|
|
78
|
-
:::
|
|
90
|
+
:::caution You must change the authentication provider before taking this to
|
|
91
|
+
**production**. Using our demo provider is not secure for production use. :::
|
|
79
92
|
|
|
80
93
|
```json
|
|
81
94
|
{
|
|
@@ -91,8 +104,10 @@ Let's walk you through everything we've set up so you know how to customize it:
|
|
|
91
104
|
|
|
92
105
|
1. **API Keys**
|
|
93
106
|
|
|
94
|
-
We've enabled API Keys on your developer portal. This connects to the API Key
|
|
95
|
-
To add API Keys for your users, create a consumer with the
|
|
107
|
+
We've enabled API Keys on your developer portal. This connects to the API Key
|
|
108
|
+
Service in Zuplo. To add API Keys for your users, create a consumer with the
|
|
109
|
+
matching email address in **Services => API Key Service** in Zuplo, or
|
|
110
|
+
[create a Consumer using the Zuplo API](https://zuplo.com/docs/api/api-keys-consumers#creates-a-consumer).
|
|
96
111
|
|
|
97
112
|
```json
|
|
98
113
|
{
|
|
@@ -107,7 +122,9 @@ Let's walk you through everything we've set up so you know how to customize it:
|
|
|
107
122
|
|
|
108
123
|
## Make It Yours
|
|
109
124
|
|
|
110
|
-
You can customize the look and feel of your documentation site by modifying the
|
|
125
|
+
You can customize the look and feel of your documentation site by modifying the
|
|
126
|
+
`theme` section in `zudoku.config.tsx`. Why not try changing the primary color
|
|
127
|
+
of your site?
|
|
111
128
|
|
|
112
129
|
```json
|
|
113
130
|
{
|
|
@@ -126,4 +143,7 @@ You can customize the look and feel of your documentation site by modifying the
|
|
|
126
143
|
}
|
|
127
144
|
```
|
|
128
145
|
|
|
129
|
-
We have extensive customization options available. From colors to fonts and
|
|
146
|
+
We have extensive customization options available. From colors to fonts and
|
|
147
|
+
borders, find the
|
|
148
|
+
[full list of options](https://zuplo.com/docs/dev-portal/zudoku/customization/colors-theme)
|
|
149
|
+
in our documentation.
|
|
@@ -2,7 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
|
-
This page demonstrates various markdown features and formatting options
|
|
5
|
+
This page demonstrates various markdown features and formatting options
|
|
6
|
+
available in our documentation system. Whether you're writing technical
|
|
7
|
+
documentation, guides, or tutorials, these examples will help you create
|
|
8
|
+
beautiful and well-structured content.
|
|
6
9
|
|
|
7
10
|
### Key Features
|
|
8
11
|
|
|
@@ -15,7 +18,8 @@ This page demonstrates various markdown features and formatting options availabl
|
|
|
15
18
|
|
|
16
19
|
## Text Formatting
|
|
17
20
|
|
|
18
|
-
You can make text **bold** or _italic_ to emphasize important points. For
|
|
21
|
+
You can make text **bold** or _italic_ to emphasize important points. For
|
|
22
|
+
technical terms, use `inline code` formatting.
|
|
19
23
|
|
|
20
24
|
### Code Examples
|
|
21
25
|
|
|
@@ -96,7 +100,9 @@ for i in range(10):
|
|
|
96
100
|
|
|
97
101
|
## Conclusion
|
|
98
102
|
|
|
99
|
-
This example demonstrates the power and flexibility of markdown for creating
|
|
103
|
+
This example demonstrates the power and flexibility of markdown for creating
|
|
104
|
+
beautiful documentation. Feel free to use these patterns in your own
|
|
105
|
+
documentation to maintain consistency and readability.
|
|
100
106
|
|
|
101
107
|
---
|
|
102
108
|
|
|
@@ -14,26 +14,35 @@ category: ""
|
|
|
14
14
|
|
|
15
15
|
Welcome to your new developer portal that makes sense. 🎉
|
|
16
16
|
|
|
17
|
-
This is your new developer portal, built with
|
|
17
|
+
This is your new developer portal, built with
|
|
18
|
+
["Zudoku by Zuplo"](https://github.com/zuplo/zudoku) and designed to elevate
|
|
19
|
+
your API documentation experience. We've streamlined the setup process so you
|
|
20
|
+
can focus on what matters most: creating exceptional developer experiences.
|
|
18
21
|
|
|
19
|
-
Think of this as your API's professional showcase—presenting your endpoints and
|
|
22
|
+
Think of this as your API's professional showcase—presenting your endpoints and
|
|
23
|
+
documentation in the best possible light. Whether you're launching innovative
|
|
24
|
+
new features or improving existing services, this portal provides the foundation
|
|
25
|
+
for clear, accessible, and engaging developer documentation.
|
|
20
26
|
|
|
21
|
-
Let's explore what we've configured for you and how you can customize it to
|
|
27
|
+
Let's explore what we've configured for you and how you can customize it to
|
|
28
|
+
perfectly match your needs.
|
|
22
29
|
|
|
23
30
|
## Let's Review Your Configuration
|
|
24
31
|
|
|
25
|
-
The developer portal is configured in the `zudoku.config.tsx` file. We've
|
|
26
|
-
|
|
32
|
+
The developer portal is configured in the `zudoku.config.tsx` file. We've
|
|
33
|
+
created a starter configuration to get you up and running quickly. Let's walk
|
|
34
|
+
you through everything we've set up so you know how to customize it:
|
|
27
35
|
|
|
28
36
|
<Stepper>
|
|
29
37
|
|
|
30
38
|
1. **Change the Basics**
|
|
31
39
|
|
|
32
|
-
First, you may want to change the title and banner we've put in place. These
|
|
40
|
+
First, you may want to change the title and banner we've put in place. These
|
|
41
|
+
are part of the `page` section in your configuration.
|
|
33
42
|
|
|
34
|
-
:::tip
|
|
35
|
-
|
|
36
|
-
:::
|
|
43
|
+
:::tip **Have a company logo?** Learn how you can
|
|
44
|
+
[add your logo](https://zuplo.com/docs/dev-portal/zudoku/configuration/page#logo)
|
|
45
|
+
in our documentation. :::
|
|
37
46
|
|
|
38
47
|
```jsx
|
|
39
48
|
{
|
|
@@ -55,8 +64,9 @@ Let's walk you through everything we've set up so you know how to customize it:
|
|
|
55
64
|
|
|
56
65
|
1. **API Reference**
|
|
57
66
|
|
|
58
|
-
Your [API Reference](/api) is generated from your Zuplo OpenAPI file in
|
|
59
|
-
|
|
67
|
+
Your [API Reference](/api) is generated from your Zuplo OpenAPI file in
|
|
68
|
+
`../routes.oas.json`—you can add other APIs whenever you need them. Improve
|
|
69
|
+
your documentation by adding more details to the OpenAPI file.
|
|
60
70
|
|
|
61
71
|
```json
|
|
62
72
|
{
|
|
@@ -71,11 +81,14 @@ Let's walk you through everything we've set up so you know how to customize it:
|
|
|
71
81
|
|
|
72
82
|
1. **Authentication & Login**
|
|
73
83
|
|
|
74
|
-
We've configured your project to use [Auth0](https://auth0.com) as an
|
|
84
|
+
We've configured your project to use [Auth0](https://auth0.com) as an
|
|
85
|
+
authentication provider with our demo account. We support many authentication
|
|
86
|
+
providers—check the
|
|
87
|
+
[documentation on how to configure](https://zuplo.com/docs/dev-portal/zudoku/configuration/authentication#authentication-providers)
|
|
88
|
+
each one.
|
|
75
89
|
|
|
76
|
-
:::caution
|
|
77
|
-
|
|
78
|
-
:::
|
|
90
|
+
:::caution You must change the authentication provider before taking this to
|
|
91
|
+
**production**. Using our demo provider is not secure for production use. :::
|
|
79
92
|
|
|
80
93
|
```json
|
|
81
94
|
{
|
|
@@ -91,8 +104,10 @@ Let's walk you through everything we've set up so you know how to customize it:
|
|
|
91
104
|
|
|
92
105
|
1. **API Keys**
|
|
93
106
|
|
|
94
|
-
We've enabled API Keys on your developer portal. This connects to the API Key
|
|
95
|
-
To add API Keys for your users, create a consumer with the
|
|
107
|
+
We've enabled API Keys on your developer portal. This connects to the API Key
|
|
108
|
+
Service in Zuplo. To add API Keys for your users, create a consumer with the
|
|
109
|
+
matching email address in **Services => API Key Service** in Zuplo, or
|
|
110
|
+
[create a Consumer using the Zuplo API](https://zuplo.com/docs/api/api-keys-consumers#creates-a-consumer).
|
|
96
111
|
|
|
97
112
|
```json
|
|
98
113
|
{
|
|
@@ -107,7 +122,9 @@ Let's walk you through everything we've set up so you know how to customize it:
|
|
|
107
122
|
|
|
108
123
|
## Make It Yours
|
|
109
124
|
|
|
110
|
-
You can customize the look and feel of your documentation site by modifying the
|
|
125
|
+
You can customize the look and feel of your documentation site by modifying the
|
|
126
|
+
`theme` section in `zudoku.config.tsx`. Why not try changing the primary color
|
|
127
|
+
of your site?
|
|
111
128
|
|
|
112
129
|
```json
|
|
113
130
|
{
|
|
@@ -126,4 +143,7 @@ You can customize the look and feel of your documentation site by modifying the
|
|
|
126
143
|
}
|
|
127
144
|
```
|
|
128
145
|
|
|
129
|
-
We have extensive customization options available. From colors to fonts and
|
|
146
|
+
We have extensive customization options available. From colors to fonts and
|
|
147
|
+
borders, find the
|
|
148
|
+
[full list of options](https://zuplo.com/docs/dev-portal/zudoku/customization/colors-theme)
|
|
149
|
+
in our documentation.
|
|
@@ -2,7 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
|
-
This page demonstrates various markdown features and formatting options
|
|
5
|
+
This page demonstrates various markdown features and formatting options
|
|
6
|
+
available in our documentation system. Whether you're writing technical
|
|
7
|
+
documentation, guides, or tutorials, these examples will help you create
|
|
8
|
+
beautiful and well-structured content.
|
|
6
9
|
|
|
7
10
|
### Key Features
|
|
8
11
|
|
|
@@ -15,7 +18,8 @@ This page demonstrates various markdown features and formatting options availabl
|
|
|
15
18
|
|
|
16
19
|
## Text Formatting
|
|
17
20
|
|
|
18
|
-
You can make text **bold** or _italic_ to emphasize important points. For
|
|
21
|
+
You can make text **bold** or _italic_ to emphasize important points. For
|
|
22
|
+
technical terms, use `inline code` formatting.
|
|
19
23
|
|
|
20
24
|
### Code Examples
|
|
21
25
|
|
|
@@ -96,7 +100,9 @@ for i in range(10):
|
|
|
96
100
|
|
|
97
101
|
## Conclusion
|
|
98
102
|
|
|
99
|
-
This example demonstrates the power and flexibility of markdown for creating
|
|
103
|
+
This example demonstrates the power and flexibility of markdown for creating
|
|
104
|
+
beautiful documentation. Feel free to use these patterns in your own
|
|
105
|
+
documentation to maintain consistency and readability.
|
|
100
106
|
|
|
101
107
|
---
|
|
102
108
|
|