forked from hexclave/hexclave
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.yml
More file actions
300 lines (296 loc) · 10.4 KB
/
Copy pathdocs.yml
File metadata and controls
300 lines (296 loc) · 10.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
instances:
- url: https://stack-auth.docs.buildwithfern.com
custom-domain: docs.stack-auth.com
edit-this-page:
github:
owner: stack-auth
repo: stack
branch: dev/docs
title: Stack Auth Documentation
js: ./custom-script.js
tabs:
documentation:
display-name: Documentation
icon: fa-solid fa-home
slug: docs
components:
display-name: Components
icon: fa-solid fa-puzzle
slug: components
sdk:
display-name: SDK Reference
icon: fa-solid fa-hammer
slug: sdk
api:
display-name: REST API & Webhooks
icon: fa-solid fa-code
slug: rest-api
navigation:
- tab: documentation
layout:
- page: Overview
icon: fa-regular fa-globe
path: ./docs/pages/overview.mdx
- page: FAQ
icon: fa-regular fa-circle-question
path: ./docs/pages/faq.mdx
- section: Getting Started
contents:
- page: Installation & Setup
icon: fa-regular fa-download
path: ./docs/pages/getting-started/setup.mdx
- page: Components
icon: fa-regular fa-puzzle
path: ./docs/pages/getting-started/components.mdx
- page: Users
icon: fa-regular fa-address-book
path: ./docs/pages/getting-started/users.mdx
- page: Going to Production
icon: fa-regular fa-rocket
path: ./docs/pages/getting-started/production.mdx
- section: Concepts
contents:
- page: The StackApp Object
icon: fa-regular fa-folder-gear
path: ./docs/pages/concepts/stack-app.mdx
- page: Custom User Data
icon: fa-regular fa-user-pen
path: ./docs/pages/concepts/custom-user-data.mdx
- page: User Onboarding
icon: fa-regular fa-user-check
path: ./docs/pages/concepts/user-onboarding.mdx
- page: Connected OAuth Accounts
icon: fa-regular fa-link
path: ./docs/pages/concepts/oauth.mdx
- page: Teams
icon: fa-regular fa-users
path: ./docs/pages/concepts/orgs-and-teams.mdx
- page: Selecting a Team
icon: fa-regular fa-exchange
path: ./docs/pages/concepts/team-selection.mdx
- page: Permissions & RBAC
icon: fa-regular fa-user-lock
path: ./docs/pages/concepts/permissions.mdx
- page: Webhooks
icon: fa-regular fa-webhook
path: ./docs/pages/concepts/webhooks.mdx
- page: Backend Integration
icon: fa-regular fa-network-wired
path: ./docs/pages/concepts/backend-integration.mdx
- section: Customization
contents:
- page: Dark/Light Mode
icon: fa-regular fa-circle-half-stroke
path: ./docs/pages/customization/dark-mode.mdx
- page: Colors and Styles
icon: fa-regular fa-paint-brush
path: ./docs/pages/customization/custom-styles.mdx
- page: Internationalization
icon: fa-regular fa-language
path: ./docs/pages/customization/internationalization.mdx
# - page: Customize Emails
# icon: fa-regular fa-envelope
- page: Custom Layouts and Pages
icon: fa-regular fa-table-layout
path: ./docs/pages/customization/custom-pages.mdx
- section: Custom Page Examples
icon: fa-regular fa-files
contents:
- page: Sign In
path: ./docs/pages/customization/page-examples/sign-in.mdx
- page: Sign Up
path: ./docs/pages/customization/page-examples/sign-up.mdx
- section: Others
contents:
- page: Supabase Integration
icon: fa-regular fa-bolt
path: ./docs/pages/others/supabase.mdx
- page: Self-Hosting
icon: fa-regular fa-house-laptop
path: ./docs/pages/others/self-host.mdx
- tab: components
layout:
- page: All Components
icon: fa-regular fa-globe
path: ./docs/pages/components/overview.mdx
- section: Components
contents:
- page: <UserButton />
icon: fa-solid fa-square-code
path: ./docs/pages/components/user-button.mdx
- page: <SelectedTeamSwitcher />
icon: fa-solid fa-square-code
path: ./docs/pages/components/selected-team-switcher.mdx
- page: <AccountSettings />
icon: fa-solid fa-square-code
path: ./docs/pages/components/account-settings.mdx
- page: <SignIn />
icon: fa-solid fa-square-code
path: ./docs/pages/components/sign-in.mdx
- page: <SignUp />
icon: fa-solid fa-square-code
path: ./docs/pages/components/sign-up.mdx
- page: <CredentialSignIn />
icon: fa-solid fa-square-code
path: ./docs/pages/components/credential-sign-in.mdx
- page: <CredentialSignUp />
icon: fa-solid fa-square-code
path: ./docs/pages/components/credential-sign-up.mdx
- page: <OAuthButton />
icon: fa-solid fa-square-code
path: ./docs/pages/components/oauth-button.mdx
- page: <OAuthButtonGroup />
icon: fa-solid fa-square-code
path: ./docs/pages/components/oauth-button-group.mdx
- section: Utilities
contents:
- page: <StackHandler />
icon: fa-solid fa-square-u
path: ./docs/pages/components/stack-handler.mdx
- page: <StackProvider />
icon: fa-solid fa-square-u
path: ./docs/pages/components/stack-provider.mdx
- page: <StackTheme />
icon: fa-solid fa-square-u
path: ./docs/pages/components/stack-theme.mdx
- tab: sdk
layout:
- page: SDK Overview
icon: fa-regular fa-globe
path: ./docs/pages/sdk/overview.mdx
- section: Objects
contents:
- section: StackApp
icon: fa-duotone fa-square-t
path: ./docs/pages/sdk/objects/stack-app.mdx
contents:
- link: StackClientApp
icon: fa-duotone fa-square-t
href: /sdk/objects/stack-app#stackclientapp
- link: StackServerApp
icon: fa-duotone fa-square-t
href: /sdk/objects/stack-app#stackserverapp
- section: Types
contents:
- section: ContactChannel
icon: fa-duotone fa-square-t
path: ./docs/pages/sdk/types/contact-channel.mdx
contents:
- link: ContactChannel
icon: fa-duotone fa-square-t
href: /sdk/types/contact-channel#contactchannel
- link: ServerContactChannel
icon: fa-duotone fa-square-t
href: /sdk/types/contact-channel#servercontactchannel
- page: Project
icon: fa-duotone fa-square-t
path: ./docs/pages/sdk/types/project.mdx
- section: Team
icon: fa-duotone fa-square-t
path: ./docs/pages/sdk/types/team.mdx
contents:
- link: Team
icon: fa-duotone fa-square-t
href: /sdk/types/team#team
- link: ServerTeam
icon: fa-duotone fa-square-t
href: /sdk/types/team#serverteam
- page: TeamPermission
icon: fa-duotone fa-square-t
path: ./docs/pages/sdk/types/team-permission.mdx
- section: TeamProfile
icon: fa-duotone fa-square-t
path: ./docs/pages/sdk/types/team-profile.mdx
contents:
- link: TeamProfile
icon: fa-duotone fa-square-t
href: /sdk/types/team-profile#teamprofile
- link: ServerTeamProfile
icon: fa-duotone fa-square-t
href: /sdk/types/team-profile#serverteamprofile
- section: TeamUser
icon: fa-duotone fa-square-t
path: ./docs/pages/sdk/types/team-user.mdx
contents:
- link: TeamUser
icon: fa-duotone fa-square-t
href: /sdk/types/team-user#teamuser
- link: ServerTeamUser
icon: fa-duotone fa-square-t
href: /sdk/types/team-user#serverteamuser
- section: User
icon: fa-duotone fa-square-t
path: ./docs/pages/sdk/types/user.mdx
contents:
- link: CurrentUser
icon: fa-duotone fa-square-t
href: /sdk/types/user#currentuser
- link: ServerUser
icon: fa-duotone fa-square-t
href: /sdk/types/user#serveruser
- link: CurrentServerUser
icon: fa-duotone fa-square-t
href: /sdk/types/user#currentserveruser
# - section: ConnectedAccount
# path: ./docs/pages/sdk/types/connected-account.mdx
- section: Hooks
contents:
- page: useStackApp()
icon: fa-duotone fa-square-h
path: ./docs/pages/sdk/hooks/use-stack-app.mdx
- page: useUser()
icon: fa-duotone fa-square-h
path: ./docs/pages/sdk/hooks/use-user.mdx
- tab: api
layout:
- page: API Overview
icon: fa-regular fa-globe
path: ./docs/pages/rest-api/overview.mdx
- api: Client API
slug: client
api-name: client
- api: Server API
slug: server
api-name: server
- api: Webhooks
slug: webhooks
api-name: webhooks
# - api: Admin API Reference
# slug: admin
# api-name: admin
navbar-links:
- type: secondary
text: Discord
url: https://discord.stack-auth.com
- type: secondary
text: GitHub
url: https://github.com/stack-auth/stack
- type: primary
text: Dashboard
url: https://app.stack-auth.com
colors:
accentPrimary:
light: '#000000'
dark: '#FFFFFF'
background:
light: '#FFFFFF'
dark: '#000000'
sidebar-background:
light: '#FCFCFC'
dark: '#090909'
card-background:
light: '#FCFCFC'
dark: '#090909'
layout:
page-width: full
content-width: 45rem
disable-header: false
header-height: 60px
sidebar-width: 300px
favicon: ./docs/assets/favicon.ico
logo:
light: ./docs/assets/logo-light-mode.svg
dark: ./docs/assets/logo-dark-mode.svg
height: 28
href: https://stack-auth.com
css: ./style.css