-
-
Notifications
You must be signed in to change notification settings - Fork 79
/
mkdocs.yml
138 lines (123 loc) · 4.48 KB
/
mkdocs.yml
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
site_name: React Auth Kit
site_description: Powerful, easy to use and Batteries enabled authentication management Library for React JS and Next Js apps, uses Token-Based Authentication using JSON Web Token
site_author: Arkadip Bhattacharya
site_url: https://authkit.arkadip.dev/
repo_url: https://github.com/react-auth-kit/react-auth-kit
repo_name: react-auth-kit/react-auth-kit
copyright: Copyright © 2020 - 2024 React Auth Kit
extra_css:
- stylesheets/extra.css
theme:
name: 'material'
custom_dir: docs/docs_overrides/
icon:
repo: fontawesome/brands/github
logo: img/logo.svg
favicon: img/favicon.png
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
toggle:
icon: material/weather-night
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
toggle:
icon: material/weather-sunny
name: Switch to light mode
features:
- content.code.annotate
- content.code.copy
- content.code.select
- navigation.indexes
- navigation.tabs
- navigation.tracking
- navigation.top
- navigation.sections
- search.highlight
- search.share
- search.suggest
- toc.follow
nav:
- Home: 'index.md'
- Getting Started:
- 'getting_started/index.md'
- Integration:
- React App (CRA, Vite): 'getting_started/integration/react-app.md'
- Next Js App Router: 'getting_started/integration/next-app-router.md'
- Functionalities:
- Sign In: 'getting_started/signin.md'
- Sign Out: 'getting_started/signout.md'
- User Data: 'getting_started/authdata.md'
- Auth Header: 'getting_started/authheader.md'
- Auth Status: 'getting_started/checkauth.md'
- Refresh Token: 'getting_started/refreshtoken.md'
- Private Route:
- React Router: 'getting_started/privateroute/react-router.md'
- Next Js App Router: 'getting_started/privateroute/next-app.md'
- Reference:
- 'reference/index.md'
- React Auth Kit:
- AuthProvider: 'reference/react-auth-kit/authprovider.md'
- createRefresh: 'reference/react-auth-kit/createRefresh.md'
- createStore: 'reference/react-auth-kit/createStore.md'
- Errors: 'reference/react-auth-kit/errors.md'
- Types: 'reference/react-auth-kit/types.md'
- Hooks:
- 'reference/react-auth-kit/hooks/index.md'
- useAuthHeader: 'reference/react-auth-kit/hooks/useAuthHeader.md'
- useAuthUser: 'reference/react-auth-kit/hooks/useAuthUser.md'
- useIsAuthenticated: 'reference/react-auth-kit/hooks/useIsAuthenticated.md'
- useSignIn: 'reference/react-auth-kit/hooks/useSignIn.md'
- useSignOut: 'reference/react-auth-kit/hooks/useSignOut.md'
- Higher Order Component:
- 'reference/react-auth-kit/hoc/index.md'
- useAuthHeader: 'reference/react-auth-kit/hoc/withAuthHeader.md'
- withAuthuser: 'reference/react-auth-kit/hoc/withAuthUser.md'
- withIsAuthenticated: 'reference/react-auth-kit/hoc/withIsAuthenticated.md'
- withSignIn: 'reference/react-auth-kit/hoc/withSignIn.md'
- withSignOut: 'reference/react-auth-kit/hoc/withSignOut.md'
- '@auth-kit/react-router':
- RequireAuth: 'reference/react-router/requireauth.md'
- AuthOutlet: 'reference/react-router/authoutlet.md'
- '@auth-kit/next':
- NextAuth: 'reference/next/next-auth.md'
- Upgradation Guide:
- 'update/index.md'
- Update from v2 to v3: 'update/2to3.md'
- Update from v1 to v2: 'update/1to2.md'
- Contributing: 'contributing.md'
extra:
analytics:
provider: google
property: G-G1WZBFV5R2
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
plugins:
- search
markdown_extensions:
- admonition
- tables
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.tabbed:
alternate_style: true
- pymdownx.superfences
- attr_list
- md_in_html
- toc:
permalink: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true