@quietmind/mdx-docs 0.1.1 → 0.1.3
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.
- package/README.md +3 -3
- package/package.json +9 -11
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
A React + Vite framework for building MDX-powered documentation sites. Write pages in Markdown with embedded React components, and get a fully-featured site with syntax highlighting, dark/light mode, and responsive navigation out of the box.
|
|
4
4
|
|
|
5
|
-
**Demo:** https://
|
|
5
|
+
**Demo:** https://mdxdocs.com/
|
|
6
6
|
|
|
7
7
|
## Features
|
|
8
8
|
|
|
@@ -114,7 +114,7 @@ export default defineConfig(
|
|
|
114
114
|
|
|
115
115
|
Create an MDX file in `pages/`:
|
|
116
116
|
|
|
117
|
-
|
|
117
|
+
~~~mdx
|
|
118
118
|
# Getting Started
|
|
119
119
|
|
|
120
120
|
This is a documentation page with **markdown** and React components.
|
|
@@ -122,7 +122,7 @@ This is a documentation page with **markdown** and React components.
|
|
|
122
122
|
```js
|
|
123
123
|
const hello = "world";
|
|
124
124
|
```
|
|
125
|
-
|
|
125
|
+
~~~
|
|
126
126
|
|
|
127
127
|
Register it in `config/pages.js`:
|
|
128
128
|
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quietmind/mdx-docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"type": "module",
|
|
5
|
-
"homepage": "https://
|
|
5
|
+
"homepage": "https://mdxdocs.com",
|
|
6
6
|
"exports": {
|
|
7
7
|
".": {
|
|
8
8
|
"import": "./dist/index.js"
|
|
@@ -20,9 +20,8 @@
|
|
|
20
20
|
"build:lib": "vite build --config vite.lib.config.js",
|
|
21
21
|
"lint": "eslint .",
|
|
22
22
|
"preview": "vite preview",
|
|
23
|
+
"publish": "yarn build:lib && npm publish",
|
|
23
24
|
"serve": "vite preview --host",
|
|
24
|
-
"predeploy": "yarn build",
|
|
25
|
-
"deploy": "gh-pages -d dist -m 'Deploy React app to GitHub Pages'",
|
|
26
25
|
"test": "vitest run",
|
|
27
26
|
"test:watch": "vitest",
|
|
28
27
|
"test:coverage": "vitest run --coverage",
|
|
@@ -47,16 +46,11 @@
|
|
|
47
46
|
"devDependencies": {
|
|
48
47
|
"@emotion/react": "^11.14.0",
|
|
49
48
|
"@emotion/styled": "^11.14.0",
|
|
49
|
+
"@eslint/js": "^9.25.0",
|
|
50
50
|
"@mdx-js/react": "^3.1.0",
|
|
51
51
|
"@mdx-js/rollup": "^3.1.0",
|
|
52
52
|
"@mui/icons-material": "^7.1.2",
|
|
53
53
|
"@mui/material": "^7.1.2",
|
|
54
|
-
"prism-react-renderer": "^2.4.1",
|
|
55
|
-
"prismjs": "^1.30.0",
|
|
56
|
-
"react": "^19.1.0",
|
|
57
|
-
"react-dom": "^19.1.0",
|
|
58
|
-
"react-router-dom": "^7.6.2",
|
|
59
|
-
"@eslint/js": "^9.25.0",
|
|
60
54
|
"@testing-library/dom": "^10.4.0",
|
|
61
55
|
"@testing-library/jest-dom": "^6.6.3",
|
|
62
56
|
"@testing-library/react": "^16.3.0",
|
|
@@ -70,10 +64,14 @@
|
|
|
70
64
|
"eslint-plugin-import": "^2.32.0",
|
|
71
65
|
"eslint-plugin-react-hooks": "^5.2.0",
|
|
72
66
|
"eslint-plugin-react-refresh": "^0.4.19",
|
|
73
|
-
"gh-pages": "^6.3.0",
|
|
74
67
|
"globals": "^16.0.0",
|
|
75
68
|
"identity-obj-proxy": "^3.0.0",
|
|
76
69
|
"jsdom": "^26.1.0",
|
|
70
|
+
"prism-react-renderer": "^2.4.1",
|
|
71
|
+
"prismjs": "^1.30.0",
|
|
72
|
+
"react": "^19.1.0",
|
|
73
|
+
"react-dom": "^19.1.0",
|
|
74
|
+
"react-router-dom": "^7.6.2",
|
|
77
75
|
"vite": "^6.4.1",
|
|
78
76
|
"vitest": "^3.2.4"
|
|
79
77
|
}
|