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