The real final todos of guider

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 NeatoJS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

apps/docs/components/home-card.module.css

@@ -0,0 +1,59 @@
+.container > * {
+  margin-bottom: 1rem;
+}
+
+.container > *:last-child {
+  margin-bottom: 0;
+}
+
+.card {
+  display: flex;
+  gap: .5rem;
+  border: 1px solid #0F2B33;
+  border-radius: 15px;
+  padding: 1.5rem;
+  transition: border-color 100ms ease-in-out;
+}
+.card:hover {
+  border-color: #1e4853;
+}
+
+.body {
+  flex: 1;
+}
+
+.right {
+  display: flex;
+  align-items: center;
+}
+
+.title {
+  font-size: 1.25rem;
+  color: white;
+  margin-bottom: 0.5rem;
+  font-weight: bold;
+  display: inline-block;
+}
+.title:hover {
+  opacity: 0.75;
+}
+
+.desc {
+  line-height: 1.3;
+  max-width: 320px;
+}
+
+.icon {
+  font-size: 1.75rem;
+  margin-top: 0.2rem;
+  color: #50A0EA;
+}
+
+@media screen and (max-width: 740px) {
+  .card {
+    flex-direction: column;
+  }
+  .right {
+    margin-top: 2rem;
+  }
+}

apps/docs/components/home-card.tsx

@@ -0,0 +1,40 @@
+import type { ReactNode } from 'react';
+import { Icon } from '@neato/guider/client';
+import Link from 'next/link';
+import styles from './home-card.module.css';
+
+function Card(props: {
+  children?: ReactNode;
+  right?: ReactNode;
+  icon: string;
+}) {
+  return (
+    <div className={styles.card}>
+      <Icon icon={props.icon} className={styles.icon} />
+      <div className={styles.body}>{props.children}</div>
+      <div className={styles.right}>{props.right}</div>
+    </div>
+  );
+}
+
+function Title(props: { children?: ReactNode; href: string }) {
+  return (
+    <Link href={props.href}>
+      <h1 className={styles.title}>{props.children}</h1>
+    </Link>
+  );
+}
+
+function Description(props: { children?: ReactNode }) {
+  return <p className={styles.desc}>{props.children}</p>;
+}
+
+export function HomeCardContainer(props: { children?: ReactNode }) {
+  return <div className={styles.container}>{props.children}</div>;
+}
+
+export const HomeCard = {
+  Card,
+  Title,
+  Description,
+};

apps/docs/components/home.module.css

@@ -0,0 +1,19 @@
+.home {
+  max-width: 750px;
+  margin: 5rem auto;
+}
+
+.title {
+  font-size: 2rem;
+  color: white;
+  margin-bottom: 1.5rem;
+  font-weight: bold;
+  max-width: 480px;
+}
+
+.subtitle {
+  font-size: 1.125rem;
+  line-height: 1.3;
+  max-width: 480px;
+  margin-bottom: 4rem;
+}

apps/docs/components/home.tsx

@@ -0,0 +1,20 @@
+import type { ReactNode } from 'react';
+import styles from './home.module.css';
+
+function Container(props: { children?: ReactNode }) {
+  return <div className={styles.home}>{props.children}</div>;
+}
+
+function Title(props: { children?: ReactNode }) {
+  return <h1 className={styles.title}>{props.children}</h1>;
+}
+
+function Subtitle(props: { children?: ReactNode }) {
+  return <p className={styles.subtitle}>{props.children}</p>;
+}
+
+export const Home = {
+  Container,
+  Title,
+  Subtitle,
+};

apps/docs/components/logo.module.css

@@ -0,0 +1,23 @@
+.logo img {
+  height: 2rem;
+  margin-right: .5rem;
+}
+
+.logo {
+  font-weight: 700;
+  color: white;
+  display: flex;
+  align-items: center;
+  transition: background-color 100ms ease-in-out, transform 100ms ease-in-out;
+  border-radius: 5px;
+  padding: .5rem;
+  margin-left: -0.5rem;
+}
+
+.logo:hover {
+  background-color: rgb(var(--colors-bgLightest));
+}
+
+.logo:active {
+  transform: scale(1.05);
+}

apps/docs/components/logo.tsx

@@ -0,0 +1,10 @@
+import Link from 'next/link';
+import styles from './logo.module.css';
+
+export function Logo() {
+  return (
+    <Link href="/" className={styles.logo}>
+      <img src="/logo.svg" /> NeatoJS
+    </Link>
+  );
+}

apps/docs/pages/_app.tsx

@@ -1,6 +1,4 @@
-import type { AppProps } from 'next/app';
 import '@neato/guider/style.css';
+import { createGuiderApp } from '@neato/guider/client';
 
-export default function MyApp({ Component, pageProps }: AppProps) {
-  return <Component {...pageProps} />;
-}
+export default createGuiderApp();

apps/docs/pages/_meta.json

@@ -0,0 +1,3 @@
+{
+  "site": "main"
+}

apps/docs/pages/docs/config/index.tsx

@@ -1,3 +1,38 @@
-import { createRedirect } from '@neato/guider/client';
+import {
+  Button,
+  Card,
+  CardGrid,
+  GuiderLayout,
+  Hero,
+} from '@neato/guider/client';
 
-export default createRedirect({ to: '/docs/config/guide/why-neat-config' });
+export default function LandingPage() {
+  return (
+    <GuiderLayout meta={{ layout: 'page' }}>
+      <Hero>
+        <Hero.Title>Simple type-safe configuration</Hero.Title>
+        <Hero.Subtitle>
+          Configure with json files or environment variables, without losing
+          type-safety
+        </Hero.Subtitle>
+        <Hero.Actions>
+          <Button to="/docs/config/guide/why-neat-config">Get started</Button>
+          <Button to="https://github.com/mrjvs/neatojs" type="secondary">
+            View on github
+          </Button>
+        </Hero.Actions>
+      </Hero>
+      <CardGrid>
+        <Card icon="mdi:cube-outline" title="Focus on writing">
+          Effortlessly create beautiful documentation sites with just markdown.
+        </Card>
+        <Card icon="mdi:cube-outline" title="Focus on writing">
+          Effortlessly create beautiful documentation sites with just markdown.
+        </Card>
+        <Card icon="mdi:cube-outline" title="Focus on writing">
+          Effortlessly create beautiful documentation sites with just markdown.
+        </Card>
+      </CardGrid>
+    </GuiderLayout>
+  );
+}

apps/docs/pages/docs/guider/api-reference/components/guider-header.mdx

@@ -0,0 +1,5 @@
+# `<GuiderHeader />`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/components/guider-layout.mdx

@@ -0,0 +1,5 @@
+# `<GuiderLayout />`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/components/guider-sidebar.mdx

@@ -0,0 +1,5 @@
+# `<GuiderSidebar />`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/components/guider-toc.mdx

@@ -0,0 +1,5 @@
+# `<GuiderToc />`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/functions/create-not-found-page.mdx

@@ -0,0 +1,5 @@
+# `createNotFoundPage()`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/functions/create-redirect.mdx

@@ -0,0 +1,5 @@
+# `createRedirect()`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/functions/use-guider-page.mdx

@@ -0,0 +1,5 @@
+# `useGuiderPage()`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/functions/use-guider.mdx

@@ -0,0 +1,5 @@
+# `useGuider()`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/index.tsx

@@ -0,0 +1,5 @@
+import { createRedirect } from '@neato/guider/client';
+
+export default createRedirect({
+  to: '/docs/guider/api-reference/theme/define-theme',
+});

apps/docs/pages/docs/guider/api-reference/meta/structure.mdx

@@ -0,0 +1,5 @@
+# Structure of `_meta.json`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/theme/component.mdx

@@ -0,0 +1,5 @@
+# `component()`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/theme/define-theme.mdx

@@ -0,0 +1,5 @@
+# `defineTheme()`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/theme/directory.mdx

@@ -0,0 +1,5 @@
+# `directory()`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/theme/group.mdx

@@ -0,0 +1,5 @@
+# `group()`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/theme/link.mdx

@@ -0,0 +1,5 @@
+# `link()`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/theme/seperator.mdx

@@ -0,0 +1,5 @@
+# `seperator()`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>

apps/docs/pages/docs/guider/api-reference/theme/site.mdx

@@ -0,0 +1,5 @@
+# `site()`
+
+<Caution>
+This article is a stub, please help by contributing to the docs.
+</Caution>