@quietmind/mdx-docs 0.1.19 → 0.1.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/README.md +12 -0
  2. package/dist/assets/Avatar-BJ0S7JKg.js +1 -0
  3. package/dist/assets/Button-BXcSdEL6.js +1 -0
  4. package/dist/assets/Favorite-DeeoxvxH.js +1 -0
  5. package/dist/assets/advanced-D_Pa36Nk.js +38 -0
  6. package/dist/assets/alert-a7rj56bx.js +191 -0
  7. package/dist/assets/button-D0caik7C.js +97 -0
  8. package/dist/assets/card-Fe9yzzA9.js +230 -0
  9. package/dist/assets/chip-CHAwrwxa.js +204 -0
  10. package/dist/assets/colors-BwOy54bA.js +8 -0
  11. package/dist/assets/customization-DuuWhJ6e.js +111 -0
  12. package/dist/assets/examples-DBDWp4fA.js +11 -0
  13. package/dist/assets/home-9ybgeCk8.js +90 -0
  14. package/dist/assets/index-C5FzG5L5.js +153 -0
  15. package/dist/assets/prism-DjoQ0BfU.js +14 -0
  16. package/dist/assets/react-vendor-BVjvCnQb.js +56 -0
  17. package/dist/assets/router-d4Dt6g8h.js +12 -0
  18. package/dist/assets/tabs-D9qsbJnd.js +215 -0
  19. package/dist/assets/textfield-D0Z_oeqU.js +253 -0
  20. package/dist/assets/typography-hshX1pgi.js +429 -0
  21. package/dist/index.html +29 -0
  22. package/package.json +1 -1
  23. package/dist/index.js +0 -1580
  24. /package/dist/{index.css → assets/index-Do1AlBnD.css} +0 -0
package/dist/assets/home-9ybgeCk8.js ADDED
@@ -0,0 +1,90 @@
1
+ import{n as o,o as n,p as i,F as r}from"./react-vendor-BVjvCnQb.js";function c(t){const e={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",li:"li",ol:"ol",p:"p",pre:"pre",ul:"ul",...o(),...t.components};return i(r,{children:[n(e.h1,{children:"MDX Docs"}),`
2
+ `,i("p",{children:[n("a",{href:"https://github.com/thequietmind/mdx-docs",style:"margin-right: 0.25rem;",children:n("img",{src:"https://img.shields.io/badge/GitHub-mdx--docs-black?logo=github",height:"32"})}),n("a",{href:"https://www.producthunt.com/posts/mdx-docs",children:n("img",{src:"https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=1095911&theme=dark",height:"32"})})]}),`
3
+ `,i(e.blockquote,{children:[`
4
+ `,n(e.p,{children:"⚡ A lightweight React framework for building MDX documentation sites."}),`
5
+ `]}),`
6
+ `,n(e.p,{children:"Welcome to the MDX Docs example site. This is the default demo site for the project. This site was built with MDX Docs."}),`
7
+ `,n(e.p,{children:"MDX Docs turns MDX files into routed documentation pages with a built-in layout, sidebar, and navigation."}),`
8
+ `,i(e.p,{children:["Check the ",n(e.a,{href:"/examples",children:"Examples page"})," to see some example pages that display React components alongside the documentation."]}),`
9
+ `,n(e.h2,{children:"Features"}),`
10
+ `,i(e.ul,{children:[`
11
+ `,n(e.li,{children:"MDX pages — write Markdown with embedded React components"}),`
12
+ `,n(e.li,{children:"Syntax highlighting with copy-to-clipboard on code blocks"}),`
13
+ `,n(e.li,{children:"Dark/light mode with system preference detection"}),`
14
+ `,n(e.li,{children:"Responsive sidebar navigation"}),`
15
+ `,n(e.li,{children:"Built on React 19, Material-UI 7, and Vite 6"}),`
16
+ `]}),`
17
+ `,n(e.h2,{children:"Quick Start"}),`
18
+ `,n(e.p,{children:"Create a new documentation site:"}),`
19
+ `,n(e.pre,{children:n(e.code,{className:"language-sh",children:`npx create-mdx-docs@latest my-docs
20
+ `})}),`
21
+ `,i(e.p,{children:["Create an MDX file in ",n(e.code,{children:"pages/"}),":"]}),`
22
+ `,n(e.pre,{children:n(e.code,{className:"language-mdx",children:`import { Button } from "@mui/material";
23
+
24
+ # Button
25
+
26
+ <Button variant="contained" color="primary">
27
+ Primary Action
28
+ </Button>
29
+
30
+ \`\`\`jsx
31
+ <Button variant="contained" color="primary">
32
+ Primary Action
33
+ </Button>
34
+ \`\`\`
35
+ `})}),`
36
+ `,i(e.p,{children:["Register your page in ",n(e.code,{children:"config/pages.js"}),":"]}),`
37
+ `,n(e.pre,{children:n(e.code,{className:"language-js",children:`const GettingStartedMDX = lazy(() => import("@pages/getting-started.mdx"));
38
+
39
+ export const pages = [
40
+ // ...existing pages
41
+ {
42
+ name: "Getting Started",
43
+ route: "/getting-started",
44
+ component: GettingStartedMDX,
45
+ },
46
+ ];
47
+ `})}),`
48
+ `,i(e.p,{children:["Pages with ",n(e.code,{children:"isDefault: true"})," do not appear in the sidebar navigation."]}),`
49
+ `,i(e.p,{children:["Configure your site name and description in ",n(e.code,{children:"config/site.js"}),"."]}),`
50
+ `,n(e.pre,{children:n(e.code,{className:"language-js",children:`export const site = {
51
+ name: "My Site",
52
+ description: "My site description",
53
+ };
54
+ `})}),`
55
+ `,n(e.h2,{children:"Favicon"}),`
56
+ `,i(e.p,{children:["Place your favicon in the ",n(e.code,{children:"public/"})," directory and add a ",n(e.code,{children:"<link>"})," tag to ",n(e.code,{children:"index.html"}),":"]}),`
57
+ `,n(e.pre,{children:n(e.code,{className:"language-html",children:`<head>
58
+ <!-- ... -->
59
+ <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
60
+ </head>
61
+ `})}),`
62
+ `,i(e.p,{children:["Vite serves files in ",n(e.code,{children:"public/"})," at the root path, so ",n(e.code,{children:"public/favicon.svg"})," is accessible as ",n(e.code,{children:"/favicon.svg"}),". Use ",n(e.code,{children:".ico"}),", ",n(e.code,{children:".png"}),", or ",n(e.code,{children:".svg"})," depending on your file."]}),`
63
+ `,n(e.h2,{children:"Project Structure"}),`
64
+ `,n(e.pre,{children:n(e.code,{className:"language-none",children:`my-docs/
65
+ ├── pages/
66
+ │ └── home.mdx
67
+ ├── config/
68
+ │ ├── pages.js
69
+ │ └── site.js
70
+ ├── public/
71
+ │ └── favicon.svg
72
+ ├── index.html
73
+ ├── main.jsx
74
+ ├── vite.config.js
75
+ └── package.json
76
+ `})}),`
77
+ `,n(e.h2,{children:"Contributing"}),`
78
+ `,n(e.p,{children:"Contributions are welcome!"}),`
79
+ `,i(e.ol,{children:[`
80
+ `,n(e.li,{children:"Fork the repo"}),`
81
+ `,n(e.li,{children:"Create a branch"}),`
82
+ `,n(e.li,{children:"Submit a pull request"}),`
83
+ `]}),`
84
+ `,n(e.p,{children:n(e.a,{href:"https://github.com/thequietmind/mdx-docs",children:"https://github.com/thequietmind/mdx-docs"})}),`
85
+ `,n(e.h2,{children:"Related Projects"}),`
86
+ `,i(e.ul,{children:[`
87
+ `,n(e.li,{children:n(e.a,{href:"https://mdxjs.com/",children:"https://mdxjs.com/"})}),`
88
+ `]}),`
89
+ `,n(e.h2,{children:"License"}),`
90
+ `,n(e.p,{children:"MIT"})]})}function a(t={}){const{wrapper:e}={...o(),...t.components};return e?n(e,{...t,children:n(c,{...t})}):c(t)}export{a as default};