From 73bc3d176162007c731601127ed39591d44c2af6 Mon Sep 17 00:00:00 2001 From: Rufus Pollock Date: Tue, 15 Jun 2021 19:24:12 +0200 Subject: [PATCH] [docs][m]: refactor to have a common layout component for all pages and a common prose layout within that for "prose" docs (everything other than front page) - refs #559. --- docs/components/Footer/index.jsx | 15 ------------ docs/components/layout.js | 35 ++++++++++++++++++++++++++ docs/components/prose.js | 13 ++++++++++ docs/pages/components.js | 41 ++++++++++++------------------- docs/pages/docs.js | 33 ++++++++++--------------- docs/pages/gallery.js | 23 ++++++----------- docs/pages/index.js | 16 +++--------- docs/pages/installation.js | 41 ++++++++++++------------------- docs/pages/learn.js | 42 ++++++++++++-------------------- docs/pages/references.js | 37 +++++++++------------------- 10 files changed, 127 insertions(+), 169 deletions(-) delete mode 100644 docs/components/Footer/index.jsx create mode 100644 docs/components/layout.js create mode 100644 docs/components/prose.js diff --git a/docs/components/Footer/index.jsx b/docs/components/Footer/index.jsx deleted file mode 100644 index 6d6ec5dd..00000000 --- a/docs/components/Footer/index.jsx +++ /dev/null @@ -1,15 +0,0 @@ -export default function Footer() { - return ( - - ) -} diff --git a/docs/components/layout.js b/docs/components/layout.js new file mode 100644 index 00000000..23b6f6bc --- /dev/null +++ b/docs/components/layout.js @@ -0,0 +1,35 @@ +import Link from 'next/link' +import Head from 'next/head' + +import Nav from '../components/Nav' + +export default function Layout({ + children, + title = 'Portal.JS', +}) { + return ( +
+ + {title} + + + + +
+ ) +} diff --git a/docs/components/prose.js b/docs/components/prose.js new file mode 100644 index 00000000..7460bde2 --- /dev/null +++ b/docs/components/prose.js @@ -0,0 +1,13 @@ +export default function Prose({ + children, + mdFile=null +}) { + return ( +
+ {mdFile && +
+ } + {children} +
+ ) +} diff --git a/docs/pages/components.js b/docs/pages/components.js index c5d34d3d..916f667a 100644 --- a/docs/pages/components.js +++ b/docs/pages/components.js @@ -1,33 +1,22 @@ -import Head from 'next/head' import Link from 'next/link' import path from 'path' -import Nav from '../components/Nav' -import Footer from '../components/Footer' + +import Layout from '../components/layout' +import Prose from '../components/prose' import { formatMD } from '../lib/utils' export default function Docs({ mdFile }) { - - return ( - <> - - Portal.js Api Documentation - - -