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

Commit bdd8ce8

Browse files
DanilAndreevDanilAndreev
committed
[API Pages] Adding extension @material-docs/react-components-docs-extension.
1 parent 5cde0bc commit bdd8ce8

File tree

4 files changed

+110
-21
lines changed

4 files changed

+110
-21
lines changed

‎.idea/inspectionProfiles/Project_Default.xml‎

Lines changed: 0 additions & 6 deletions
This file was deleted.

‎package.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@
2929
},
3030
"license": "MIT",
3131
"dependencies": {
32-
"@material-docs/core": "^0.3.6",
32+
"@material-docs/core": "^0.4.1",
33+
"@material-docs/react-components-docs-extension": "^0.1.5",
3334
"@material-ui/core": "^4.11.0",
3435
"@material-ui/icons": "^4.9.1",
3536
"clsx": "^1.1.1",

‎src/pages/APIs/AutoDocsMenuAPI/index.js‎

Lines changed: 68 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,31 +8,89 @@ import React from "react";
88
import {H2, List, ListItem, useLang} from "@material-docs/core";
99
import ApiPage from "../../../components/ApiPage";
1010
import Link from "@material-docs/core/components/Link/Link";
11+
import ReactComponentApiPage from "@material-docs/react-components-docs-extension/components/ReactComponentApiPage";
12+
import ReactComponentApiPageSummary
13+
from "@material-docs/react-components-docs-extension/components/ReactComponentApiPageSummary";
14+
import ReactComponentApiPageImport
15+
from "@material-docs/react-components-docs-extension/components/ReactComponentApiPageImport";
16+
import ReactComponentApiPageProps
17+
from "@material-docs/react-components-docs-extension/components/ReactComponentApiPageProps";
18+
import ReactComponentApiPageStyles
19+
from "@material-docs/react-components-docs-extension/components/ReactComponentApiPageStyles";
20+
import ReactComponentApiPageFooter
21+
from "@material-docs/react-components-docs-extension/components/ReactComponentApiPageFooter";
22+
import Style from "@material-docs/react-components-docs-extension/components/Style";
23+
import Prop from "@material-docs/react-components-docs-extension/components/Prop";
24+
import Markdown from "@material-docs/core/components/Markdown/Markdown";
25+
import {H3} from "@material-docs/core/components/H3/H3";
26+
import Code from "@material-docs/core/components/Code/Code";
1127

1228
const importCode = `
1329
import {AutoDocsMenu} from "@material-docs/core";
1430
// or
1531
import AutoDocsMenu from "@material-docs/core/components/AutoDocsMenu";
1632
`.trim();
1733

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+
// }
55+
1856
export default function AutoDocsMenuAPI() {
1957
const {lang} = useLang();
2058
const locale = lang.locale.pages.AutoDocsMenuAPI;
2159
const localeSpells = lang.locale.common.spells;
2260
const componentAPILocale = lang.locale.common.ComponentAPI;
2361

62+
console.log(lang);
63+
2464
return (
25-
<ApiPage
26-
lang={lang}
27-
localeName={"AutoDocsMenuAPI"}
28-
searchTags={["auto", "menu", "docs", "system", "api"]}
65+
<ReactComponentApiPage
2966
name={"AutoDocsMenu"}
30-
importCode={importCode}
67+
searchDescription={"AutoDocsMenu - react component for creating automated menu."}
68+
69+
searchTags={["auto", "menu", "docs", "system", "api"]}
3170
>
32-
<H2>Demos</H2>
33-
<List>
34-
<ListItem><Link page={["Components", "Layout"]}>Layout</Link></ListItem>
35-
</List>
36-
</ApiPage>
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>*/}
94+
</ReactComponentApiPage>
3795
);
3896
}

‎yarn.lock‎

Lines changed: 40 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1301,10 +1301,33 @@
13011301
"@types/yargs" "^15.0.0"
13021302
chalk "^4.0.0"
13031303

1304-
"@material-docs/core@^0.3.6":
1305-
version "0.3.6"
1306-
resolved "https://registry.yarnpkg.com/@material-docs/core/-/core-0.3.6.tgz#06f58bd27b86d195455b20ed2623ef2e0a7e21ae"
1307-
integrity sha512-m7/8Cbx0POgZfawirVMpA4f/M81IVdl30VtDRWmN0c7HKb+rQ7PvGgS1Xcq5jNjD7C5K5gURr+qs8K66YMP1/Q==
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==
1308+
dependencies:
1309+
"@material-ui/core" "^4.11.0"
1310+
"@material-ui/icons" "^4.9.1"
1311+
"@material-ui/styles" "^4.10.0"
1312+
clsx "^1.1.1"
1313+
helmet "^4.1.0"
1314+
lodash "^4.17.20"
1315+
marked "^1.1.1"
1316+
notistack "^0.9.17"
1317+
prop-types "^15.7.2"
1318+
react "^16.13.1"
1319+
react-dom "^16.13.1"
1320+
react-helmet-async "^1.0.6"
1321+
react-lazy-load-image-component "^1.5.0"
1322+
react-router-dom "^5.2.0"
1323+
react-scripts "3.4.1"
1324+
react-syntax-highlighter "^13.0.0"
1325+
routing-manager "^2.0.4"
1326+
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==
13081331
dependencies:
13091332
"@material-ui/core" "^4.11.0"
13101333
"@material-ui/icons" "^4.9.1"
@@ -1324,6 +1347,19 @@
13241347
react-syntax-highlighter "^13.0.0"
13251348
routing-manager "^2.0.4"
13261349

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==
1354+
dependencies:
1355+
"@material-docs/core" "^0.4.2"
1356+
"@material-ui/core" "^4.11.0"
1357+
"@material-ui/styles" "^4.10.0"
1358+
clsx "^1.1.1"
1359+
react "^16.13.1"
1360+
react-dom "^16.13.1"
1361+
react-scripts "3.4.3"
1362+
13271363
"@material-ui/core@^4.11.0":
13281364
version "4.11.0"
13291365
resolved "https://registry.yarnpkg.com/@material-ui/core/-/core-4.11.0.tgz#b69b26e4553c9e53f2bfaf1053e216a0af9be15a"

0 commit comments

Comments
 (0)