Skip to content
This repository was archived by the owner on Nov 16, 2022. It is now read-only.

Commit 1bdc29d

Browse files
committed
[webpack] Added raw loader.
1 parent bdd8ce8 commit 1bdc29d

File tree

6 files changed

+110
-92
lines changed

6 files changed

+110
-92
lines changed

craco.config.js

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
const rawLoader = require('craco-raw-loader')
2+
3+
module.exports = {
4+
plugins: [
5+
{
6+
plugin: rawLoader,
7+
options: {test: /\.md$/}
8+
}
9+
]
10+
}

package.json

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,14 @@
2929
},
3030
"license": "MIT",
3131
"dependencies": {
32-
"@material-docs/core": "^0.4.1",
33-
"@material-docs/react-components-docs-extension": "^0.1.5",
32+
"@craco/craco": "^5.6.4",
33+
"@material-docs/core": "^0.4.3",
34+
"@material-docs/react-components-docs-extension": "^0.1.7",
3435
"@material-ui/core": "^4.11.0",
3536
"@material-ui/icons": "^4.9.1",
3637
"clsx": "^1.1.1",
38+
"craco-raw-loader": "^1.0.1",
39+
"raw-loader": "^4.0.1",
3740
"react": "^16.13.1",
3841
"react-dom": "^16.13.1",
3942
"react-parallax": "^3.0.3",
@@ -45,9 +48,9 @@
4548
"@testing-library/user-event": "^7.1.2"
4649
},
4750
"scripts": {
48-
"start": "react-scripts start",
49-
"build": "react-scripts build",
50-
"test": "react-scripts test",
51+
"start": "craco start",
52+
"build": "craco build",
53+
"test": "craco test",
5154
"eject": "react-scripts eject"
5255
},
5356
"eslintConfig": {
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import {AutoDocsMenu} from "@material-docs/core";
2+
// or
3+
import AutoDocsMenu from "@material-docs/core/components/AutoDocsMenu";

src/pages/APIs/AutoDocsMenuAPI/index.js

Lines changed: 22 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -22,75 +22,43 @@ import ReactComponentApiPageFooter
2222
import Style from "@material-docs/react-components-docs-extension/components/Style";
2323
import Prop from "@material-docs/react-components-docs-extension/components/Prop";
2424
import Markdown from "@material-docs/core/components/Markdown/Markdown";
25-
import {H3} from "@material-docs/core/components/H3/H3";
25+
import H3 from "@material-docs/core/components/H3";
2626
import Code from "@material-docs/core/components/Code/Code";
27-
28-
const importCode = `
29-
import {AutoDocsMenu} from "@material-docs/core";
30-
// or
31-
import AutoDocsMenu from "@material-docs/core/components/AutoDocsMenu";
32-
`.trim();
33-
34-
// export default function AutoDocsMenuAPI() {
35-
// const {lang} = useLang();
36-
// const locale = lang.locale.pages.AutoDocsMenuAPI;
37-
// const localeSpells = lang.locale.common.spells;
38-
// const componentAPILocale = lang.locale.common.ComponentAPI;
39-
//
40-
// return (
41-
// <ApiPage
42-
// lang={lang}
43-
// localeName={"AutoDocsMenuAPI"}
44-
// searchTags={["auto", "menu", "docs", "system", "api"]}
45-
// name={"AutoDocsMenu"}
46-
// importCode={importCode}
47-
// >
48-
// <H2>Demos</H2>
49-
// <List>
50-
// <ListItem><Link page={["Components", "Layout"]}>Layout</Link></ListItem>
51-
// </List>
52-
// </ApiPage>
53-
// );
54-
// }
27+
import importCode from "./importCode.md";
5528

5629
export default function AutoDocsMenuAPI() {
5730
const {lang} = useLang();
5831
const locale = lang.locale.pages.AutoDocsMenuAPI;
5932
const localeSpells = lang.locale.common.spells;
6033
const componentAPILocale = lang.locale.common.ComponentAPI;
6134

62-
console.log(lang);
63-
6435
return (
6536
<ReactComponentApiPage
6637
name={"AutoDocsMenu"}
6738
searchDescription={"AutoDocsMenu - react component for creating automated menu."}
6839

6940
searchTags={["auto", "menu", "docs", "system", "api"]}
7041
>
71-
{/*<ReactComponentApiPageSummary>*/}
72-
{/* <H3>The API documentation of the React component.</H3>*/}
73-
{/*</ReactComponentApiPageSummary>*/}
74-
{/*<ReactComponentApiPageImport>*/}
75-
{/* <Code theme={"darcula"}>*/}
76-
{/* import Component from "./lib/MyComponent";*/}
77-
{/* import Component from "./lib";*/}
78-
{/* </Code>*/}
79-
{/* <Markdown>*/}
80-
{/* You can learn more about the difference by [reading this guide](https://...).*/}
81-
{/* </Markdown>*/}
82-
{/*</ReactComponentApiPageImport>*/}
83-
{/*<ReactComponentApiPageProps>*/}
84-
{/* <Prop name={"children"} type={"node"} def={"null"}>Children of an element</Prop>*/}
85-
{/* <Prop name={"name"} type={"string"} def={"\"\""}>Your name</Prop>*/}
86-
{/*</ReactComponentApiPageProps>*/}
87-
{/*<ReactComponentApiPageStyles>*/}
88-
{/* <Style name={"root"} global={"Mui-root"}>Styles applied to the root element</Style>*/}
89-
{/* <Style name={"link"} global={"Mui-link"}>Styles applied to the link element</Style>*/}
90-
{/*</ReactComponentApiPageStyles>*/}
91-
{/*<ReactComponentApiPageFooter>*/}
92-
{/* More information...*/}
93-
{/*</ReactComponentApiPageFooter>*/}
42+
<ReactComponentApiPageSummary>
43+
<H3>The API documentation of the React component.</H3>
44+
</ReactComponentApiPageSummary>
45+
<ReactComponentApiPageImport>
46+
<Code theme={"darcula"}>{importCode}</Code>
47+
<Markdown>
48+
You can learn more about the difference by [reading this guide](https://...).
49+
</Markdown>
50+
</ReactComponentApiPageImport>
51+
<ReactComponentApiPageProps>
52+
<Prop name={"children"} type={"node"} def={"null"}>Children of an element</Prop>
53+
<Prop name={"name"} type={"string"} def={"\"\""}>Your name</Prop>
54+
</ReactComponentApiPageProps>
55+
<ReactComponentApiPageStyles>
56+
<Style name={"root"} global={"Mui-root"}>Styles applied to the root element</Style>
57+
<Style name={"link"} global={"Mui-link"}>Styles applied to the link element</Style>
58+
</ReactComponentApiPageStyles>
59+
<ReactComponentApiPageFooter>
60+
More information...
61+
</ReactComponentApiPageFooter>
9462
</ReactComponentApiPage>
9563
);
9664
}

src/pages/MaterialDocsLanding/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export default function MaterialDocsLanding() {
4747
<Button
4848
size={"large"}
4949
className={classes.getStartedButton}
50-
onClick={event => {debugger; switchPage(["Getting started", "Installation"])}}
50+
onClick={event => switchPage(["Getting started", "Installation"])}
5151
>
5252
Get started
5353
</Button>

yarn.lock

Lines changed: 66 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1085,6 +1085,15 @@
10851085
exec-sh "^0.3.2"
10861086
minimist "^1.2.0"
10871087

1088+
"@craco/craco@^5.6.4":
1089+
version "5.6.4"
1090+
resolved "https://registry.yarnpkg.com/@craco/craco/-/craco-5.6.4.tgz#de7a707c727864f39e6afc192fb6732c3ca45f90"
1091+
integrity sha512-/Qi6yPMOBC7SEZJEDI5vYaPiGFs7HzO4AAZkGB0W3MX2OCw4u4FZC+ZO6TBptGzM3QLrF7WFt5AyQnXhNBcn3A==
1092+
dependencies:
1093+
cross-spawn "^7.0.0"
1094+
lodash "^4.17.15"
1095+
webpack-merge "^4.2.2"
1096+
10881097
"@csstools/convert-colors@^1.4.0":
10891098
version "1.4.0"
10901099
resolved "https://registry.yarnpkg.com/@csstools/convert-colors/-/convert-colors-1.4.0.tgz#ad495dc41b12e75d588c6db8b9834f08fa131eb7"
@@ -1301,10 +1310,10 @@
13011310
"@types/yargs" "^15.0.0"
13021311
chalk "^4.0.0"
13031312

1304-
"@material-docs/core@^0.4.1":
1305-
version "0.4.1"
1306-
resolved "https://registry.yarnpkg.com/@material-docs/core/-/core-0.4.1.tgz#00fa9b8556989dee26594174af002ad3dadcafd9"
1307-
integrity sha512-41ryomVh9xS9iZligetuSmTKWLQgb3CpxDkAe33ZFkD1PA04iyAfR0mJXz9xWd4e8W6bQ1aFCXJMnlaPx9flcQ==
1313+
"@material-docs/core@^0.4.3":
1314+
version "0.4.3"
1315+
resolved "https://registry.yarnpkg.com/@material-docs/core/-/core-0.4.3.tgz#c945cd153af68822670d64c098d6ccb8496507cf"
1316+
integrity sha512-MLtRphlPMOVNtFWJH1WUJXFnmtWNX2SVE7mEbO73pLxovJEt6U6LjO/hVBznYf8HtxB3pd3jwfHOE2/yS8cPew==
13081317
dependencies:
13091318
"@material-ui/core" "^4.11.0"
13101319
"@material-ui/icons" "^4.9.1"
@@ -1324,35 +1333,12 @@
13241333
react-syntax-highlighter "^13.0.0"
13251334
routing-manager "^2.0.4"
13261335

1327-
"@material-docs/core@^0.4.2":
1328-
version "0.4.2"
1329-
resolved "https://registry.yarnpkg.com/@material-docs/core/-/core-0.4.2.tgz#adedf66982d26dc85d824b661ae6c0a663d69cfd"
1330-
integrity sha512-qu3A0m70MKEt1wl5SIOJg+V9+UL/LFOa7cjKaLg5MRYe57UUNum+Bdr0+viwNfLH/ylrQT1p01LIJViv3tn2lw==
1331-
dependencies:
1332-
"@material-ui/core" "^4.11.0"
1333-
"@material-ui/icons" "^4.9.1"
1334-
"@material-ui/styles" "^4.10.0"
1335-
clsx "^1.1.1"
1336-
helmet "^4.1.0"
1337-
lodash "^4.17.20"
1338-
marked "^1.1.1"
1339-
notistack "^0.9.17"
1340-
prop-types "^15.7.2"
1341-
react "^16.13.1"
1342-
react-dom "^16.13.1"
1343-
react-helmet-async "^1.0.6"
1344-
react-lazy-load-image-component "^1.5.0"
1345-
react-router-dom "^5.2.0"
1346-
react-scripts "3.4.1"
1347-
react-syntax-highlighter "^13.0.0"
1348-
routing-manager "^2.0.4"
1349-
1350-
"@material-docs/react-components-docs-extension@^0.1.5":
1351-
version "0.1.5"
1352-
resolved "https://registry.yarnpkg.com/@material-docs/react-components-docs-extension/-/react-components-docs-extension-0.1.5.tgz#e246aa74a677eb82f7e229218c95ad15f7c75d44"
1353-
integrity sha512-Ok6hyCukSZ36i3iBgDhB9SLztKZzpmICqCvgMDlcnocWcGMCGZPEHzJDXff6mZPmlINqkX1vF/Ehlbnsi43K4w==
1336+
"@material-docs/react-components-docs-extension@^0.1.7":
1337+
version "0.1.7"
1338+
resolved "https://registry.yarnpkg.com/@material-docs/react-components-docs-extension/-/react-components-docs-extension-0.1.7.tgz#c3d63ae6ce63e38371872be960cce0e4a45ec6df"
1339+
integrity sha512-77vaQSd4lVovfu3oVu+3VFwNdSM4yMHSpJolcaZ7vRxCBEwkv4mWFhPugMLtdbUXmlgbTELYKk+4fBT9jDmfYg==
13541340
dependencies:
1355-
"@material-docs/core" "^0.4.2"
1341+
"@material-docs/core" "^0.4.3"
13561342
"@material-ui/core" "^4.11.0"
13571343
"@material-ui/styles" "^4.10.0"
13581344
clsx "^1.1.1"
@@ -3424,6 +3410,13 @@ cosmiconfig@^6.0.0:
34243410
path-type "^4.0.0"
34253411
yaml "^1.7.2"
34263412

3413+
craco-raw-loader@^1.0.1:
3414+
version "1.0.1"
3415+
resolved "https://registry.yarnpkg.com/craco-raw-loader/-/craco-raw-loader-1.0.1.tgz#db04660a24419b09988a5b2651e627a9c3a35d2a"
3416+
integrity sha512-Xxtvc72WWzmkZIGJmb65c6kg7ErhHuUDH2xjY+vkouZH3W0RgeT4GN6etEDkjHvSJmFcPH9lAUXkt+xK7ks+JQ==
3417+
dependencies:
3418+
raw-loader "^1.0.0"
3419+
34273420
create-ecdh@^4.0.0:
34283421
version "4.0.3"
34293422
resolved "https://registry.yarnpkg.com/create-ecdh/-/create-ecdh-4.0.3.tgz#c9111b6f33045c4697f144787f9254cdc77c45ff"
@@ -3475,6 +3468,15 @@ cross-spawn@^6.0.0, cross-spawn@^6.0.5:
34753468
shebang-command "^1.2.0"
34763469
which "^1.2.9"
34773470

3471+
cross-spawn@^7.0.0:
3472+
version "7.0.3"
3473+
resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.3.tgz#f73a85b9d5d41d045551c177e2882d4ac85728a6"
3474+
integrity sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==
3475+
dependencies:
3476+
path-key "^3.1.0"
3477+
shebang-command "^2.0.0"
3478+
which "^2.0.1"
3479+
34783480
crypto-browserify@^3.11.0:
34793481
version "3.12.0"
34803482
resolved "https://registry.yarnpkg.com/crypto-browserify/-/crypto-browserify-3.12.0.tgz#396cf9f3137f03e4b8e532c58f698254e00f80ec"
@@ -6882,6 +6884,15 @@ loader-utils@^1.1.0, loader-utils@^1.2.3, loader-utils@^1.4.0:
68826884
emojis-list "^3.0.0"
68836885
json5 "^1.0.1"
68846886

6887+
loader-utils@^2.0.0:
6888+
version "2.0.0"
6889+
resolved "https://registry.yarnpkg.com/loader-utils/-/loader-utils-2.0.0.tgz#e4cace5b816d425a166b5f097e10cd12b36064b0"
6890+
integrity sha512-rP4F0h2RaWSvPEkD7BLDFQnvSf+nK+wr3ESUjNTyAGobqrijmW92zc+SO6d4p4B1wh7+B/Jg1mkQe5NYUEHtHQ==
6891+
dependencies:
6892+
big.js "^5.2.2"
6893+
emojis-list "^3.0.0"
6894+
json5 "^2.1.2"
6895+
68856896
locate-path@^2.0.0:
68866897
version "2.0.0"
68876898
resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-2.0.0.tgz#2b568b265eec944c6d9c0de9c3dbbbca0354cd8e"
@@ -9082,6 +9093,22 @@ raw-body@2.4.0:
90829093
iconv-lite "0.4.24"
90839094
unpipe "1.0.0"
90849095

9096+
raw-loader@^1.0.0:
9097+
version "1.0.0"
9098+
resolved "https://registry.yarnpkg.com/raw-loader/-/raw-loader-1.0.0.tgz#3f9889e73dadbda9a424bce79809b4133ad46405"
9099+
integrity sha512-Uqy5AqELpytJTRxYT4fhltcKPj0TyaEpzJDcGz7DFJi+pQOOi3GjR/DOdxTkTsF+NzhnldIoG6TORaBlInUuqA==
9100+
dependencies:
9101+
loader-utils "^1.1.0"
9102+
schema-utils "^1.0.0"
9103+
9104+
raw-loader@^4.0.1:
9105+
version "4.0.1"
9106+
resolved "https://registry.yarnpkg.com/raw-loader/-/raw-loader-4.0.1.tgz#14e1f726a359b68437e183d5a5b7d33a3eba6933"
9107+
integrity sha512-baolhQBSi3iNh1cglJjA0mYzga+wePk7vdEX//1dTFd+v4TsQlQE0jitJSNF1OIP82rdYulH7otaVmdlDaJ64A==
9108+
dependencies:
9109+
loader-utils "^2.0.0"
9110+
schema-utils "^2.6.5"
9111+
90859112
react-app-polyfill@^1.0.6:
90869113
version "1.0.6"
90879114
resolved "https://registry.yarnpkg.com/react-app-polyfill/-/react-app-polyfill-1.0.6.tgz#890f8d7f2842ce6073f030b117de9130a5f385f0"
@@ -11301,6 +11328,13 @@ webpack-manifest-plugin@2.2.0:
1130111328
object.entries "^1.1.0"
1130211329
tapable "^1.0.0"
1130311330

11331+
webpack-merge@^4.2.2:
11332+
version "4.2.2"
11333+
resolved "https://registry.yarnpkg.com/webpack-merge/-/webpack-merge-4.2.2.tgz#a27c52ea783d1398afd2087f547d7b9d2f43634d"
11334+
integrity sha512-TUE1UGoTX2Cd42j3krGYqObZbOD+xF7u28WB7tfUordytSjbWTIjK/8V0amkBfTYN4/pB/GIDlJZZ657BGG19g==
11335+
dependencies:
11336+
lodash "^4.17.15"
11337+
1130411338
webpack-sources@^1.1.0, webpack-sources@^1.4.0, webpack-sources@^1.4.1, webpack-sources@^1.4.3:
1130511339
version "1.4.3"
1130611340
resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-1.4.3.tgz#eedd8ec0b928fbf1cbfe994e22d2d890f330a933"

0 commit comments

Comments
 (0)