diff --git a/app/docs/getting-started.mdx b/app/docs/getting-started.mdx index 8204a10..08deac4 100644 --- a/app/docs/getting-started.mdx +++ b/app/docs/getting-started.mdx @@ -1,16 +1,19 @@ --- -title: Getting Started with SuperUI. +title: Getting Started tags: - react - tailwindcss date: "2022-08-05" description: SuperUI is a amazing UI library for React. --- +#### Design goals -# 🚀 Getting Started - -Install SuperUI: +Install SuperUI ```bash -npm install superui +npm install ``` + +#### Accessibility + +The design system follow WCAG standards as best it can (continuely improved!) via the use of [Radix-UI](https://www.radix-ui.com/) base components and accessible default themes. \ No newline at end of file diff --git a/app/public/fonts/CascadiaCode.woff2 b/app/public/fonts/CascadiaCode.woff2 new file mode 100644 index 0000000..8865499 Binary files /dev/null and b/app/public/fonts/CascadiaCode.woff2 differ diff --git a/app/public/fonts/Inter-Medium.woff2 b/app/public/fonts/Inter-Medium.woff2 deleted file mode 100644 index f92498a..0000000 Binary files a/app/public/fonts/Inter-Medium.woff2 and /dev/null differ diff --git a/app/public/fonts/Inter-Regular.woff2 b/app/public/fonts/Inter-Regular.woff2 deleted file mode 100644 index 6c2b689..0000000 Binary files a/app/public/fonts/Inter-Regular.woff2 and /dev/null differ diff --git a/app/public/fonts/inter-var-latin.woff2 b/app/public/fonts/inter-var-latin.woff2 new file mode 100644 index 0000000..2fbab97 Binary files /dev/null and b/app/public/fonts/inter-var-latin.woff2 differ diff --git a/app/src/components/documents/mdx/index.tsx b/app/src/components/documents/mdx/index.tsx new file mode 100644 index 0000000..5eaa8ff --- /dev/null +++ b/app/src/components/documents/mdx/index.tsx @@ -0,0 +1,68 @@ +import { + Divider, + Heading, + ListItem, + OrderedList, + Table, + Tbody, + Td, + Text, + Th, + Thead, + Tr, + UnorderedList, + Link, + TableColumnHeaderProps, + ListProps, + TableProps, + TextProps, + TableRowProps, + TableBodyProps, + HeadingProps, + LinkProps, + ListItemProps, +} from "@chakra-ui/react"; + +export const MDXComponents = { + a: (props: LinkProps) => ( + + ), + hr: (props: TextProps) => , + h1: (props: HeadingProps) => ( + + ), + h2: (props: HeadingProps) => ( + + ), + h3: (props: HeadingProps) => ( + + ), + h4: (props: HeadingProps) => ( + + ), + h5: (props: HeadingProps) => ( + + ), + h6: (props: HeadingProps) => ( + + ), + p: (props: TextProps) => , + table: (props: TableProps) => ( + + ), + thead: (props: TableBodyProps) => , + tbody: (props: TableBodyProps) => , + th: (props: TableColumnHeaderProps) => , + td: (props: TableColumnHeaderProps) =>
, + tr: (props: TableRowProps) =>
, + ul: (props: ListProps) => , + ol: (props: ListProps) => , + li: (props: ListItemProps) => , +}; diff --git a/app/src/components/documents/sidebar/content.tsx b/app/src/components/documents/sidebar/content.tsx index 869c144..dafde82 100644 --- a/app/src/components/documents/sidebar/content.tsx +++ b/app/src/components/documents/sidebar/content.tsx @@ -29,7 +29,7 @@ const SidebarContent = (props: SidebarContentProps) => { overflowX="hidden" overflowY="auto" borderRightWidth="1px" - w="60" + w="240px" {...props} > diff --git a/app/src/pages/_app.tsx b/app/src/pages/_app.tsx index a05d67b..fe9aeeb 100644 --- a/app/src/pages/_app.tsx +++ b/app/src/pages/_app.tsx @@ -30,13 +30,13 @@ function MyApp({ Component, pageProps }: AppProps) { showOnShallow={true} options={{ showSpinner: false }} /> - - - + + + - - - + + + ); } diff --git a/app/src/pages/docs/[slug].tsx b/app/src/pages/docs/[slug].tsx index 26de55e..7613449 100644 --- a/app/src/pages/docs/[slug].tsx +++ b/app/src/pages/docs/[slug].tsx @@ -11,10 +11,7 @@ interface DocsPageProps { } // Custom Components => -import Image from "next/image"; -const MDXComponents = { - Image, -}; +import { MDXComponents } from "@/components/documents/mdx"; // Plugins => import matter from "gray-matter"; @@ -23,6 +20,7 @@ import rehypePrism from "rehype-prism-plus"; import { MDXRemote, MDXRemoteSerializeResult } from "next-mdx-remote"; import { serialize } from "next-mdx-remote/serialize"; import Sidebar from "@/components/documents/sidebar"; +import { Box, Heading, Text } from "@chakra-ui/react"; const Doc = ({ source, frontMatter }: DocsPageProps) => { return ( @@ -30,6 +28,12 @@ const Doc = ({ source, frontMatter }: DocsPageProps) => { {frontMatter.title} + + + {frontMatter.title} + + {frontMatter.description} + ); diff --git a/app/src/styles/docsTheme.ts b/app/src/styles/docsTheme.ts index d06454e..c008c7e 100644 --- a/app/src/styles/docsTheme.ts +++ b/app/src/styles/docsTheme.ts @@ -17,8 +17,9 @@ const docsTheme = extendTheme({ }, }, fonts: { - body: "Inter-Regular, sans-serif", - heading: "Inter-Medium, sans-serif", + body: "Inter, sans-serif", + heading: "Inter, sans-serif", + mono: "Cascadia, monospace", }, styles: { global: (props: ChakraProps) => ({ diff --git a/app/src/styles/globals.css b/app/src/styles/globals.css index 9953a05..fa9de87 100644 --- a/app/src/styles/globals.css +++ b/app/src/styles/globals.css @@ -3,15 +3,15 @@ @tailwind utilities; @font-face { - font-family: "Inter-Regular"; + font-family: "Inter"; font-style: normal; font-display: optional; - src: url("/fonts/Inter-Regular.woff2") format("woff2"); + src: url("/fonts/inter-var-latin.woff2") format("woff2"); } @font-face { - font-family: "Inter-Medium"; + font-family: "Cascadia"; font-style: normal; font-display: optional; - src: url("/fonts/Inter-Medium.woff2") format("woff2"); + src: url("/fonts/CascadiaCode.woff2") format("woff2"); } \ No newline at end of file diff --git a/app/src/styles/prism.css b/app/src/styles/prism.css index d3bd501..1e1f019 100644 --- a/app/src/styles/prism.css +++ b/app/src/styles/prism.css @@ -1,9 +1,9 @@ pre[class*="language-"], code[class*="language-"] { color: #d4d4d4; - font-size: 13px; + font-size: 16px; text-shadow: none; - font-family: Menlo, Monaco, Consolas, "Andale Mono", "Ubuntu Mono", "Courier New", monospace; + font-family: "Cascadia"; direction: ltr; text-align: left; white-space: pre; @@ -38,7 +38,9 @@ pre[class*="language-"] { padding: 1em; margin: .5em 0; overflow: auto; - background: #1e1e1e; + background: #131314; + border: 1px solid #323236; + border-radius: 5px; } :not(pre) > code[class*="language-"] {