mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
e86425a460
* added sign in/up/out component docs * added docs for stack handler * fixed doc links * fixed image url
146 lines
4.3 KiB
YAML
146 lines
4.3 KiB
YAML
instances:
|
|
- url: https://stack-auth.docs.buildwithfern.com
|
|
custom-domain: docs.stack-auth.com
|
|
title: Stack Auth Documentation
|
|
|
|
tabs:
|
|
documentation:
|
|
display-name: Documentation
|
|
icon: fa-solid fa-home
|
|
slug: docs
|
|
sdk:
|
|
display-name: SDK Reference
|
|
icon: fa-solid fa-hammer
|
|
slug: sdk
|
|
api:
|
|
display-name: API Reference
|
|
icon: fa-solid fa-code
|
|
slug: rest-api
|
|
|
|
navigation:
|
|
- tab: documentation
|
|
layout:
|
|
- section: Get Started
|
|
contents:
|
|
- page: Overview
|
|
icon: fa-regular fa-globe
|
|
path: ./docs/pages/getting-started/overview.mdx
|
|
- page: Installation & Setup
|
|
icon: fa-regular fa-download
|
|
path: ./docs/pages/getting-started/setup.mdx
|
|
- page: Users
|
|
icon: fa-regular fa-address-book
|
|
path: ./docs/pages/getting-started/users.mdx
|
|
# - page: Protecting Pages
|
|
# icon: fa-regular fa-shield-check
|
|
# path: ./docs/pages/getting-started/protecting-pages.mdx
|
|
- page: Going to Production
|
|
icon: fa-regular fa-rocket
|
|
path: ./docs/pages/getting-started/production.mdx
|
|
- section: Concepts
|
|
contents:
|
|
# - page: Client vs. Server
|
|
# icon: fa-regular fa-code-branch
|
|
- page: OAuth Providers
|
|
icon: fa-regular fa-key
|
|
path: ./docs/pages/concepts/oauth.mdx
|
|
- page: Teams
|
|
icon: fa-regular fa-users
|
|
path: ./docs/pages/concepts/teams.mdx
|
|
- page: Selecting a Team
|
|
icon: fa-regular fa-exchange
|
|
path: ./docs/pages/concepts/team-selection.mdx
|
|
- page: Permissions
|
|
icon: fa-regular fa-user-lock
|
|
path: ./docs/pages/concepts/permissions.mdx
|
|
# - page: Local Development
|
|
# icon: fa-regular fa-laptop
|
|
- 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: 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
|
|
- tab: sdk
|
|
layout:
|
|
- section: Classes
|
|
contents:
|
|
- page: CurrentUser
|
|
path: ./docs/pages/sdk/current-user.mdx
|
|
- page: StackApp
|
|
path: ./docs/pages/sdk/stack-app.mdx
|
|
- section: Hooks
|
|
contents:
|
|
- page: useStackApp
|
|
path: ./docs/pages/sdk/use-stack-app.mdx
|
|
- page: useUser
|
|
path: ./docs/pages/sdk/use-user.mdx
|
|
- section: Components
|
|
contents:
|
|
- page: StackHandler
|
|
path: ./docs/pages/sdk/stack-handler.mdx
|
|
- page: SignIn
|
|
path: ./docs/pages/sdk/sign-in.mdx
|
|
- page: SignUp
|
|
path: ./docs/pages/sdk/sign-up.mdx
|
|
- page: SignOut
|
|
path: ./docs/pages/sdk/sign-out.mdx
|
|
|
|
- tab: api
|
|
layout:
|
|
- api: Client API Reference
|
|
slug: client
|
|
api-name: client
|
|
- api: Server API Reference
|
|
slug: server
|
|
api-name: server
|
|
|
|
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: 40rem
|
|
disable-header: false
|
|
header-height: 60px
|
|
favicon: ./docs/assets/favicon.ico
|
|
logo:
|
|
light: ./docs/assets/logo-light-mode.svg
|
|
dark: ./docs/assets/logo-dark-mode.svg
|
|
height: 28
|