Skip to content

Commit d4386da

Browse files
authored
[docs-infra] Deploy Docs to Netlify (#1019)
1 parent 9510dc2 commit d4386da

File tree

49 files changed

+356
-195
lines changed

Some content is hidden

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

49 files changed

+356
-195
lines changed

docs/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
This package contains the documentation for the MUI Infra project, which is responsible for the infrastructure and tooling used in the various MUI documentation sites and libraries.
44

55
[Read in Markdown](<./app/(shared)/page.mdx>)
6-
[Read in Browser](https://infra.mui.com)
6+
7+
[Read in Browser](https://mui-internal.netlify.app/)
78

89
For the most immersive experience, we recommend opening this documentation in VSCode, starting with this README and working deeper into the documentation by navigating through the links provided (ctrl + click). You should have [the MDX extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) installed to view the documentation properly.
910

docs/app/docs-infra/components/code-controller-context/demos/code-editor/CodeEditorContent.module.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,7 @@
3535
padding: 6px;
3636
overflow-x: auto;
3737
}
38+
39+
.codeBlock:focus-visible {
40+
outline: none;
41+
}

docs/app/docs-infra/components/code-controller-context/demos/demo-live/DemoLiveContent.module.css

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,3 +70,7 @@
7070
padding: 6px;
7171
overflow-x: auto;
7272
}
73+
74+
.codeBlock:focus-visible {
75+
outline: none;
76+
}

docs/app/docs-infra/components/code-controller-context/demos/multi-file/MultiFileEditor.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,17 @@ export default function App() {
2323
'styles.css': {
2424
source: `.container {
2525
padding: 20px;
26-
background: #f5f5f5;
26+
background: #f2eff3;
2727
border-radius: 8px;
2828
}
2929
3030
h1 {
31-
color: #333;
31+
color: #84828e;
3232
margin-bottom: 10px;
3333
}
3434
3535
p {
36-
color: #666;
36+
color: #65636d;
3737
font-size: 14px;
3838
}`,
3939
},

docs/app/docs-infra/functions/abstract-create-demo-client/page.mdx renamed to docs/app/docs-infra/factories/abstract-create-demo-client/page.mdx

File renamed without changes.

docs/app/docs-infra/functions/abstract-create-demo/page.mdx renamed to docs/app/docs-infra/factories/abstract-create-demo/page.mdx

File renamed without changes.

docs/app/docs-infra/functions/create-demo-data/page.mdx renamed to docs/app/docs-infra/factories/create-demo-data/page.mdx

File renamed without changes.
File renamed without changes.
Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
# Factories
2+
3+
[//]: # 'This file is autogenerated, but the following list can be modified.'
4+
5+
<PagesIndex>
6+
7+
- [Abstract Create Demo](#abstract-create-demo) - [Full Docs](./abstract-create-demo/page.mdx)
8+
- [Create Sitemap](#create-sitemap) [New] - [Full Docs](./create-sitemap/page.mdx)
9+
- [Abstract Create Demo Client](#abstract-create-demo-client) - [Full Docs](./abstract-create-demo-client/page.mdx)
10+
- [Create Demo Data](#create-demo-data) - [Full Docs](./create-demo-data/page.mdx)
11+
12+
[//]: # 'This file is autogenerated, DO NOT EDIT AFTER THIS LINE, run: pnpm docs:validate docs-infra/factories'
13+
14+
## Abstract Create Demo
15+
16+
The `abstractCreateDemo` function helps you create structured demo factories that work seamlessly with the [`CodeHighlighter`](../../components/code-highlighter/page.mdx) component ecosystem. It provides a standardized way to create demos that combine component previews with code display, making it easier to build consistent documentation interfaces.
17+
18+
<details>
19+
20+
<summary>Outline</summary>
21+
22+
- Sections:
23+
- Overview
24+
- Factory Function Requirements
25+
- Implementation
26+
- Global Dependencies
27+
- Loader Configuration
28+
- Related
29+
30+
</details>
31+
32+
[Read more](./abstract-create-demo/page.mdx)
33+
34+
## Create Sitemap
35+
36+
The `createSitemap` factory function defines sitemap data for documentation sites. It works with the webpack loader for build-time precomputation in Next.js builds.
37+
38+
<details>
39+
40+
<summary>Outline</summary>
41+
42+
- Sections:
43+
- Overview
44+
- API Reference
45+
- Parameters
46+
- Returns
47+
- Behavior
48+
- Runtime Loading
49+
- File Structure
50+
- Type Definitions
51+
- CreateSitemapMeta
52+
- Sitemap
53+
- SitemapSectionData
54+
- SitemapPage
55+
- Configuration
56+
- Skip Precomputation
57+
- Webpack Loader Setup
58+
- Integration with Search
59+
- Populating the Sitemap
60+
- Related
61+
62+
</details>
63+
64+
[Read more](./create-sitemap/page.mdx)
65+
66+
## Abstract Create Demo Client
67+
68+
The `abstractCreateDemoClient` function helps you create client-side demo providers that manage external dependencies for live component demos. It creates provider components that supply externals context to child components, enabling dynamic code execution in the browser.
69+
70+
<details>
71+
72+
<summary>Outline</summary>
73+
74+
- Sections:
75+
- Overview
76+
- When to Use Demo Clients
77+
- Factory Function Requirements
78+
- Implementation
79+
- Usage Pattern
80+
- Client Provider Features
81+
- Configuration Options
82+
- AbstractCreateDemoClientOptions
83+
- CreateDemoClientMeta
84+
- Externals Context
85+
- Best Practices
86+
- Example: Complete Live Demo Setup
87+
- Related
88+
89+
</details>
90+
91+
[Read more](./abstract-create-demo-client/page.mdx)
92+
93+
## Create Demo Data
94+
95+
The `createDemoData` utility creates structured demo metadata and component data for use with the [`CodeHighlighter`](../components/code-highlighter/page.mdx) system. It processes demo URLs, components, and metadata to create data objects that can be consumed by demo factories and code highlighting systems.
96+
97+
<details>
98+
99+
<summary>Outline</summary>
100+
101+
- Sections:
102+
- Features
103+
- Usage
104+
- Global Demo Data Structure
105+
- Global Variant Matching
106+
- When to Use
107+
- Related
108+
109+
</details>
110+
111+
[Read more](./create-demo-data/page.mdx)
112+
113+
</PagesIndex>
114+
115+
[//]: # 'This file is autogenerated, but the following metadata can be modified.'
116+
117+
export const metadata = {
118+
robots: {
119+
index: false,
120+
},
121+
};

docs/app/docs-infra/hooks/use-url-hash-state/demos/tab-navigation/TabNavigation.module.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
display: flex;
1212
gap: 0;
1313
border-bottom: 1px solid #d0cdd7;
14-
background-color: #f5f5f5;
14+
background-color: #f2eff3;
1515
}
1616

1717
.tab,

0 commit comments

Comments
 (0)