Skip to content

POC for new flow of documentation #2179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 36 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
3cb311c
add base IB from W3A docs
yashovardhan Jul 21, 2025
d982214
fixes
yashovardhan Jul 21, 2025
40f9596
Further fixes
yashovardhan Jul 21, 2025
365db92
Add highlighting and blur magic comments
yashovardhan Jul 21, 2025
ee98e23
fix css issues
yashovardhan Jul 21, 2025
7a34afd
Fix scrolling
yashovardhan Jul 21, 2025
8fb6ba6
Add MM SDK & DTK products in quick start
yashovardhan Jul 22, 2025
d90cbc8
Fix CSS issues
yashovardhan Jul 22, 2025
dc92bea
Update pane
yashovardhan Jul 22, 2025
a5c68c0
quick-start -> playground
yashovardhan Jul 25, 2025
17ef2b1
Update home page
yashovardhan Jul 25, 2025
a295f68
Update nav bar
yashovardhan Jul 28, 2025
8569a06
add base IB from W3A docs
yashovardhan Jul 21, 2025
9fd72c0
fixes
yashovardhan Jul 21, 2025
bcef9d7
Further fixes
yashovardhan Jul 21, 2025
5a88cb6
Add highlighting and blur magic comments
yashovardhan Jul 21, 2025
434ecbb
fix css issues
yashovardhan Jul 21, 2025
c319d22
Fix scrolling
yashovardhan Jul 21, 2025
961d05e
Add MM SDK & DTK products in quick start
yashovardhan Jul 22, 2025
83073b3
Fix CSS issues
yashovardhan Jul 22, 2025
8d99b04
Update pane
yashovardhan Jul 22, 2025
2a82a0c
quick-start -> playground
yashovardhan Jul 25, 2025
bab15ec
Update home page
yashovardhan Jul 25, 2025
d2a72d4
Update nav bar
yashovardhan Jul 28, 2025
f97120a
Merge branch 'feat/quick-start' of https://github.com/MetaMask/metama…
yashovardhan Jul 28, 2025
a159d05
Fix build
yashovardhan Jul 28, 2025
98e3a6d
Fix build issues
yashovardhan Jul 28, 2025
3086e0f
Fix highlighting error
yashovardhan Jul 28, 2025
e41a0f3
Remove DTK from builder
yashovardhan Jul 29, 2025
3576ac3
Add overlay on builder
yashovardhan Jul 29, 2025
4154d3c
Update NavigationFlow.tsx
yashovardhan Jul 29, 2025
480a09b
Update builder UI
yashovardhan Jul 29, 2025
219cdc5
fix css issues
yashovardhan Jul 29, 2025
fbdb4e4
playground -> quickstart
yashovardhan Jul 30, 2025
2ae8dde
Update QS
yashovardhan Aug 6, 2025
82156d1
Update react qs
yashovardhan Aug 6, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@
npm-debug.log*
.vercel
.envrc
.env
.env
.integrationBuilderCache
97 changes: 58 additions & 39 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,21 @@ const {
MM_RPC_URL,
} = require('./src/plugins/plugin-json-rpc')
const codeTheme = themes.dracula
const helpDropdown = fs.readFileSync('./src/components/NavDropdown/DeveloperTools.html', 'utf-8')
const connectDropdown = fs.readFileSync(
'./src/components/NavDropdown/ConnectMetaMask.html',
const productsDropdown = fs.readFileSync(
'./src/components/NavDropdown/Products.html',
'utf-8'
)
const embedDropdown = fs.readFileSync('./src/components/NavDropdown/EmbedMetaMask.html', 'utf-8')
const extendDropdown = fs.readFileSync('./src/components/NavDropdown/ExtendScale.html', 'utf-8')
const baseUrl = process.env.DEST || '/';
const siteUrl = 'https://docs.metamask.io';

const npm2yarnPlugin = [require('@docusaurus/remark-plugin-npm2yarn'), { sync: true }]
/** @type {import('@docusaurus/types').Config} */
const siteUrl = 'https://docs.metamask.io'
const baseUrl = process.env.DEST || '/'
const fullUrl = new URL(baseUrl, siteUrl).toString()
const config = {
title: 'MetaMask developer documentation',
// tagline: '',
url: 'https://docs.metamask.io',
baseUrl: process.env.DEST || '/', // overwritten in github action for staging / latest
baseUrl, // overwritten in github action for staging / latest
onBrokenLinks: 'warn',
onBrokenMarkdownLinks: 'warn',
favicon: 'img/favicons/favicon-96x96.png',
Expand Down Expand Up @@ -110,6 +108,16 @@ const config = {
trailingSlash: true,

scripts: [
{
src: baseUrl + "js/fix-trailing-slash.js",
async: false,
defer: false,
},
{
src: baseUrl + "js/code-focus.js",
async: false,
defer: true,
},
{
src: 'https://cmp.osano.com/AzZMxHTbQDOQD8c1J/84e64bce-4a70-4dcc-85cb-7958f22b2371/osano.js',
},
Expand All @@ -133,13 +141,28 @@ const config = {
breadcrumbs: false,
remarkPlugins: [npm2yarnPlugin],
},
pages: {
path: 'src/pages',
routeBasePath: '/',
include: ['**/**.{js,jsx,ts,tsx,md,mdx}'],
exclude: [
'**/_*.{js,jsx,ts,tsx,md,mdx}',
'**/_*/**',
'**/*.test.{js,jsx,ts,tsx}',
'**/__tests__/**',
'**/quickstart/**', // Exclude quickstart directory from pages plugin
],
mdxPageComponent: '@theme/MDXPage',
remarkPlugins: [npm2yarnPlugin],
},
theme: {
customCss: require.resolve('./src/scss/custom.scss'),
},
},
],
],
plugins: [
['./src/plugins/docusaurus-plugin-virtual-files', { rootDir: '.integrationBuilderCache' }],
'docusaurus-plugin-sass',
'./src/plugins/mm-scss-utils',
[
Expand Down Expand Up @@ -336,47 +359,28 @@ const config = {
items: [
{
type: 'dropdown',
label: 'Connect to MetaMask',
label: 'Products',
items: [
{
type: 'html',
value: connectDropdown,
value: productsDropdown,
},
],
},
{
type: 'dropdown',
label: 'Embed MetaMask',
items: [
{
type: 'html',
value: embedDropdown,
},
],
},
{
type: 'dropdown',
label: 'Extend and scale',
items: [
{
type: 'html',
value: extendDropdown,
},
],
label: 'Quick Start',
to: '/quickstart',
position: 'left',
},
{
type: 'dropdown',
label: 'Developer tools',
items: [
{
type: 'html',
value: helpDropdown,
},
],
to: 'developer-tools/faucet/',
label: "Faucet",
position: 'right',
excludeUrl: REF_ALLOW_LOGIN_PATH,
},
{
to: 'whats-new',
label: "What's new?",
to: 'https://community.metamask.io/',
label: "Help ↗",
position: 'right',
},
{
Expand Down Expand Up @@ -524,6 +528,21 @@ const config = {
theme: codeTheme,
additionalLanguages: ['csharp', 'gradle', 'bash', 'json'],
magicComments: [
{
className: 'theme-code-block-highlighted-line',
line: 'highlight-next-line',
block: { start: 'highlight-start', end: 'highlight-end' },
},
{
className: "code-unfocus",
line: "unfocus-next-line",
block: { start: "unfocus-start", end: "unfocus-end" },
},
{
className: "code-focus",
line: "focus-next-line",
block: { start: "focus-start", end: "focus-end" },
},
{
className: 'git-diff-remove',
line: 'remove-next-line',
Expand Down Expand Up @@ -554,7 +573,7 @@ const config = {
// Optional: Replace parts of the item URLs from Algolia. Useful when using the same search index for multiple deployments using a different baseUrl. You can use regexp or string in the `from` param. For example: localhost:3000 vs myCompany.com/docs
replaceSearchResultPathname: {
from: '/',
to: process.env.DEST || '/',
to: baseUrl,
},

// Optional: Algolia search parameters
Expand Down
Loading
Loading