Skip to content

Commit 6bf78f6

Browse files
yashovardhanbgravenorstihsraham
authored
W3a docs (#2255)
* wip * update examples * Add embedded wallets intro page * Fix issues * Add sub nav bar * Update sidebarsectiondropdown styling * restructure ew docs * Fix troubleshooting sidebar * Update links in guides * Fix CI build error. Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> * restructure dashboard section * fix linting issues * Update naming conventions * Update features section * Fix build issues * updates * fixes * migration guides restructure * update flutter documentation * Structure update for unreal, unity & ios * Updated Connect Blockchain section * Removed unused files * edited troubleshooting docs * Web3Auth references to EW in authentication Updated documentation to replace 'Web3Auth' with 'Embedded Wallets' throughout authentication and troubleshooting guides. Adjusted dashboard references, titles, descriptions, and internal links to reflect the new branding and clarify SDK naming conventions. * react native structure update * Update content for SDKs * Update react native content --------- Signed-off-by: bgravenorst <byron.gravenorst@consensys.net> Co-authored-by: Yashovardhan Agrawal <21066442+yashovardhan@users.noreply.github.com> Co-authored-by: bgravenorst <byron.gravenorst@consensys.net> Co-authored-by: Maharshi Mishra <ihsraham27@gmail.com>
1 parent 55a84c8 commit 6bf78f6

File tree

1,115 files changed

+85422
-1547
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,115 files changed

+85422
-1547
lines changed

docusaurus.config.js

Lines changed: 41 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,12 @@ const productsDropdown = fs.readFileSync('./src/components/NavDropdown/Products.
1616
const baseUrl = process.env.DEST || '/'
1717
const siteUrl = 'https://docs.metamask.io'
1818

19-
const npm2yarnPlugin = [require('@docusaurus/remark-plugin-npm2yarn'), { sync: true }]
19+
const remarkPlugins = [
20+
require('remark-math'),
21+
[require('@docusaurus/remark-plugin-npm2yarn'), { sync: true }]
22+
]
23+
24+
const rehypePlugins = [[require('rehype-katex'), { strict: false }]]
2025
/** @type {import('@docusaurus/types').Config} */
2126
const fullUrl = new URL(baseUrl, siteUrl).toString()
2227
const config = {
@@ -136,7 +141,8 @@ const config = {
136141
editUrl: 'https://github.com/MetaMask/metamask-docs/edit/main/',
137142
sidebarPath: false,
138143
breadcrumbs: false,
139-
remarkPlugins: [npm2yarnPlugin],
144+
remarkPlugins,
145+
rehypePlugins,
140146
},
141147
pages: {
142148
path: 'src/pages',
@@ -149,7 +155,8 @@ const config = {
149155
'**/__tests__/**',
150156
],
151157
mdxPageComponent: '@theme/MDXPage',
152-
remarkPlugins: [npm2yarnPlugin],
158+
remarkPlugins,
159+
rehypePlugins,
153160
},
154161
theme: {
155162
customCss: require.resolve('./src/scss/custom.scss'),
@@ -171,7 +178,8 @@ const config = {
171178
editUrl: 'https://github.com/MetaMask/metamask-docs/edit/main/',
172179
sidebarPath: require.resolve('./snaps-sidebar.js'),
173180
breadcrumbs: false,
174-
remarkPlugins: [npm2yarnPlugin],
181+
remarkPlugins,
182+
rehypePlugins,
175183
admonitions: {
176184
keywords: [
177185
'info',
@@ -197,7 +205,8 @@ const config = {
197205
editUrl: 'https://github.com/MetaMask/metamask-docs/edit/main/',
198206
sidebarPath: require.resolve('./gator-sidebar.js'),
199207
breadcrumbs: false,
200-
remarkPlugins: [npm2yarnPlugin],
208+
remarkPlugins,
209+
rehypePlugins,
201210
sidebarCollapsed: false,
202211
includeCurrentVersion: true,
203212
// Set to the latest release.
@@ -225,7 +234,8 @@ const config = {
225234
editUrl: 'https://github.com/MetaMask/metamask-docs/edit/main/',
226235
sidebarPath: require.resolve('./services-sidebar.js'),
227236
breadcrumbs: false,
228-
remarkPlugins: [npm2yarnPlugin],
237+
remarkPlugins,
238+
rehypePlugins,
229239
},
230240
],
231241
[
@@ -237,7 +247,8 @@ const config = {
237247
editUrl: 'https://github.com/MetaMask/metamask-docs/edit/main/',
238248
sidebarPath: require.resolve('./dashboard-sidebar.js'),
239249
breadcrumbs: false,
240-
remarkPlugins: [npm2yarnPlugin],
250+
remarkPlugins,
251+
rehypePlugins,
241252
},
242253
],
243254
[
@@ -249,7 +260,8 @@ const config = {
249260
editUrl: 'https://github.com/MetaMask/metamask-docs/edit/main/',
250261
sidebarPath: require.resolve('./wallet-sidebar.js'),
251262
breadcrumbs: false,
252-
remarkPlugins: [npm2yarnPlugin],
263+
remarkPlugins,
264+
rehypePlugins,
253265
sidebarItemsGenerator: async function ({ defaultSidebarItemsGenerator, ...args }) {
254266
const sidebarItems = await defaultSidebarItemsGenerator(args)
255267
const dynamicItems = await fetchAndGenerateDynamicSidebarItems(
@@ -273,7 +285,22 @@ const config = {
273285
editUrl: 'https://github.com/MetaMask/metamask-docs/edit/main/',
274286
sidebarPath: require.resolve('./sdk-sidebar.js'),
275287
breadcrumbs: false,
276-
remarkPlugins: [npm2yarnPlugin],
288+
remarkPlugins,
289+
rehypePlugins,
290+
},
291+
],
292+
293+
[
294+
'@docusaurus/plugin-content-docs',
295+
{
296+
id: 'embedded-wallets',
297+
path: 'embedded-wallets',
298+
routeBasePath: 'embedded-wallets',
299+
editUrl: 'https://github.com/MetaMask/metamask-docs/edit/main/',
300+
sidebarPath: require.resolve('./ew-sidebar.js'),
301+
breadcrumbs: false,
302+
remarkPlugins,
303+
rehypePlugins,
277304
},
278305
],
279306
'./src/plugins/plugin-json-rpc.ts',
@@ -426,6 +453,10 @@ const config = {
426453
label: 'Delegation Toolkit',
427454
to: '/delegation-toolkit',
428455
},
456+
{
457+
label: 'Embedded Wallets',
458+
to: '/embedded-wallets',
459+
},
429460
{
430461
label: 'Snaps',
431462
to: '/snaps',
@@ -527,7 +558,7 @@ const config = {
527558
},
528559
prism: {
529560
theme: codeTheme,
530-
additionalLanguages: ['csharp', 'gradle', 'bash', 'json'],
561+
additionalLanguages: ['csharp', 'gradle', 'bash', 'json', 'java', 'kotlin', 'swift', 'groovy', 'dart'],
531562
magicComments: [
532563
{
533564
className: 'theme-code-block-highlighted-line',

embedded-wallets/README.mdx

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
---
2+
title: What are Embedded Wallets?
3+
image: 'img/docs-meta-cards/documentation-card.png'
4+
sidebar_label: What are Embedded Wallets?
5+
description: 'What are MetaMask Embedded Wallets? | Documentation - MetaMask Embedded Wallets'
6+
---
7+
8+
import BrowserOnly from '@docusaurus/BrowserOnly'
9+
10+
import Tiles from '@theme/Tiles'
11+
12+
export const GetStarted = [
13+
{
14+
name: '',
15+
description: '',
16+
tiles: [
17+
{
18+
key: 'react',
19+
title: 'React',
20+
icon: 'logo-react.png',
21+
path: '/embedded-wallets/sdk/react',
22+
},
23+
{
24+
key: 'vue',
25+
title: 'Vue',
26+
icon: 'logo-vue.png',
27+
path: '/embedded-wallets/sdk/vue',
28+
},
29+
{
30+
key: 'js',
31+
title: 'JavaScript',
32+
icon: 'logo-js.png',
33+
path: '/embedded-wallets/sdk/js',
34+
},
35+
{
36+
key: 'android',
37+
title: 'Android',
38+
icon: 'logo-android.png',
39+
path: '/embedded-wallets/sdk/android',
40+
},
41+
{
42+
key: 'ios',
43+
title: 'iOS',
44+
icon: 'logo-apple.png',
45+
path: '/embedded-wallets/sdk/ios',
46+
},
47+
{
48+
key: 'react-native',
49+
title: 'React Native',
50+
icon: 'logo-react.png',
51+
path: '/embedded-wallets/sdk/react-native',
52+
},
53+
{
54+
key: 'flutter',
55+
title: 'Flutter',
56+
icon: 'logo-flutter.png',
57+
path: '/embedded-wallets/sdk/flutter',
58+
},
59+
{
60+
key: 'unity',
61+
title: 'Unity',
62+
icon: 'logo-unity.png',
63+
path: '/embedded-wallets/sdk/unity',
64+
},
65+
{
66+
key: 'unreal',
67+
title: 'Unreal Engine',
68+
icon: 'logo-unreal.png',
69+
path: '/embedded-wallets/sdk/unreal',
70+
},
71+
],
72+
73+
}, ]
74+
75+
MetaMask Embedded Wallets (formerly Web3Auth) is a pluggable embedded wallet infrastructure that simplifies Web3 wallet integration and user onboarding. It supports OAuth-based logins and multiple platforms, allowing users to access Web3 applications through familiar authentication methods in under a minute.
76+
77+
Users enjoy seamless onboarding while maintaining full control of their non-custodial wallets, ensuring both convenience and security.
78+
79+
:::note
80+
81+
The SDKs are now branded as MetaMask Embedded Wallet SDKs (formerly Web3Auth Plug and Play SDKs). Package names and APIs remain Web3Auth (for example, Web3Auth React SDK), and code snippets may reference `web3auth` identifiers.
82+
83+
:::
84+
85+
## Get Started
86+
87+
<Tiles tileGroups={GetStarted} />
88+
89+
## Key Features
90+
91+
<BrowserOnly>
92+
{() => {
93+
const ModalAnim = require('@site/src/components/ModalAnim').default
94+
return <ModalAnim />
95+
}}
96+
</BrowserOnly>
97+
98+
### 🔐 Authentication Made Simple
99+
100+
Get your users started in seconds with familiar login methods they already use:
101+
102+
- Sign in with Google, Twitter, GitHub and other popular social accounts
103+
- Passwordless login via email, SMS, authenticator apps or passkeys
104+
- Bring your own auth system while leveraging our secure wallet infrastructure
105+
106+
### 🛡️ Bank-Grade Security
107+
108+
Enterprise-level protection for your users' digital assets:
109+
110+
- Advanced MPC technology splits keys across multiple parties
111+
- Users maintain 100% control of their non-custodial wallets
112+
- Distributed architecture prevents single points of failure
113+
- Multiple backup options for worry-free recovery
114+
115+
### 💻 Built for Developers
116+
117+
Integrate MetaMask Embedded Wallets into your app with minimal effort:
118+
119+
- Drop-in solution works with your existing auth system
120+
- No complex migrations or infrastructure changes needed
121+
- Full control to customize the look and feel
122+
- Support for web, mobile, and gaming platforms
123+
124+
### 👥 Designed for Users
125+
126+
The smoothest path to Web3 for your users:
127+
128+
- Get started in under 60 seconds
129+
- No crypto knowledge needed
130+
- Users own and control their wallets
131+
- Simple, reliable account recovery

0 commit comments

Comments
 (0)