Add documentation (#91)

* Add documentation * Don't run on docs update * Added docs but it is not working * First iteration * Add `umd-global` ts support * TODO: * Start over * Init a new nextjs 13 project * Add nextra * Finally, It works! * Fix tailwind styling * Add landing page * fix href
wanjohiryan · Oct 13, 2023 · 630bfa1 · 630bfa1
1 parent e9f981b
commit 630bfa1
Show file tree

Hide file tree

Showing 25 changed files with 4,412 additions and 0 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,36 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+
+This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
diff --git a/docs/app/favicon.ico b/docs/app/favicon.ico
diff --git a/docs/app/layout.tsx b/docs/app/layout.tsx
@@ -0,0 +1,28 @@
+import '../styles/globals.css'
+import type { Metadata } from 'next'
+
+export const metadata: Metadata = {
+  title: 'Create Next App',
+  description: 'Generated by create next app',
+}
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode
+}) {
+  return (
+    <html lang="en">
+      <head>
+        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+        <link
+          rel="preload"
+          href="/fonts/SF-Pro-Bold.otf"
+          as="font"
+          crossOrigin=""
+        />
+      </head>
+      <body>{children}</body>
+    </html>
+  )
+}
diff --git a/docs/app/page.tsx b/docs/app/page.tsx
@@ -0,0 +1,73 @@
+"use client"
+import { motion, useMotionValue, useTransform } from 'framer-motion'
+import LogoGradient from '@/svg/LogoGradient'
+import LogoName from '@/svg/LogoName'
+import Link from 'next/link'
+import ChevronRight from '@/svg/ChevronRight'
+import Logo from '@/svg/Logo'
+
+const marqueeVariants = {
+  animate: {
+    x: [0, -1035],
+    transition: {
+      x: {
+        repeat: Infinity,
+        repeatType: "loop",
+        duration: 30,
+        ease: "linear",
+      },
+    },
+  },
+};
+
+export default function Home() {
+
+  const pathLength = useMotionValue(0)
+  const opacity = useTransform(pathLength, [0.05, 0.15], [0, 1])
+
+  return (
+    <main className='min-h-full w-auto items-center justify-start bg-black flex flex-col gap-3'>
+      <header className='items-center bg-black flex flex-row gap-4 h-20 p-7 fixed z-10 left-0 top-0 justify-between w-full'>
+        <a href="/" className="flex items-center delay-75 cursor-pointer">
+          <div className='overflow-hidden rounded-xl'>
+            <LogoGradient className='h-[35px] w-[35px] sm:h-[50px] sm:w-[50px]' />
+          </div>
+          <LogoName className='w-[8rem] sm:w-[10rem] sm:h-[4rem]' />
+        </a>
+        <Link target="_blank" href="https://github.com/wanjohiryan/arc3dia" className="group relative inline-flex items-center overflow-hidden rounded-2xl h-min w-min py-1.5 px-2.5 text-lg outline-none text-black transition duration-300 bg-white focus:ring-[0.1875rem] focus:ring-accent sm:flex">
+          <div className="ease translate-x-0 font-semibold transition duration-300 group-hover:-translate-x-8">
+            Github
+          </div>
+          <div className="ease absolute right-5 translate-x-full opacity-0 transition duration-300 group-hover:translate-x-0 group-hover:opacity-100" >
+            <ChevronRight viewBox="0 0 60 80" className="h-[24px] w-[24px] stroke-current stroke-2" />
+          </div>
+        </Link>
+        <div className='-bottom-2.5 h-2.5 left-0 absolute r-0 w-full'>
+          <motion.div
+            variants={marqueeVariants}
+            animate="animate"
+            className='w-full h-full bg-transparent bg-[url(/images/wave.svg)] bg-[length:40px_8px] bg-repeat-x turn-stile'></motion.div>
+        </div>
+      </header>
+      <section className='pt-40 relative w-full items-center justify-center flex flex-col gap-10 h-min overflow-hidden'>
+        {/**LOGO */}
+        <div className='h-[256px] w-[256px] relative'>
+          {/**BG */}
+          <div className='relative flex items-center justify-center h-full w-full'>
+            <div className="blur-logo scale-80" />
+            <div className="slogan scale-80" />
+          </div>
+          <div className='inset-0 opacity-[.1] rounded-3xl overflow-hidden absolute h-full aspect-square items-center flex'>
+            <div className='bg-[url(/images/inter.png)] bg-repeat bg-[length:64px] w-full h-full rounded-0' />
+          </div>
+        </div>
+        <div className='outline-none flex flex-col justify-start relative'>
+          <h1 className='text-[80px] leading-[.9em] text-white max-w-1/2 text-center flex flex-col justify-center items-center'>
+            {/* Start building with <br /> */}
+            <LogoName className='w-[8rem] sm:w-[20rem] sm:h-[4rem]' />
+          </h1>
+        </div>
+      </section>
+    </main>
+  )
+}
diff --git a/docs/next.config.mjs b/docs/next.config.mjs
@@ -0,0 +1,21 @@
+import nextra from 'nextra'
+
+const withNextra = nextra({
+    // Tell Nextra to use the custom theme as the layout
+    theme: './src/index.tsx',
+    themeConfig: './theme.config.tsx',
+    defaultShowCopyCode: true,
+    flexsearch: {
+      codeblocks: true
+    },
+    codeHighlight: true
+  })
+
+  export default withNextra({
+    reactStrictMode: true,
+    swcMinify: true,
+  })
+
+  process.on('unhandledRejection', error => {
+    console.log('unhandledRejection', error)
+  })
diff --git a/docs/package.json b/docs/package.json
@@ -0,0 +1,28 @@
+{
+  "name": "docs",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "framer-motion": "^10.16.4",
+    "next": "latest",
+    "nextra": "^2.13.1",
+    "nextra-theme-docs": "^2.13.1",
+    "react": "latest",
+    "react-dom": "latest"
+  },
+  "devDependencies": {
+    "@types/node": "latest",
+    "@types/react": "latest",
+    "@types/react-dom": "latest",
+    "autoprefixer": "latest",
+    "postcss": "latest",
+    "tailwindcss": "latest",
+    "typescript": "latest"
+  }
+}
diff --git a/docs/pages/_app.tsx b/docs/pages/_app.tsx
@@ -0,0 +1,10 @@
+import { AppProps } from "next/app";
+import '../styles/globals.css'
+
+export default function MyApp({ Component, pageProps }: AppProps) {
+    return (
+        <>
+            <Component {...pageProps} />
+        </>
+    )
+}
diff --git a/docs/pages/_meta.json b/docs/pages/_meta.json
@@ -0,0 +1,14 @@
+{
+    "index": {
+        "title": "Home",
+        "display": "hidden",
+        "theme": {
+            "layout": "raw"
+        }
+    },
+    "docs": {
+        "title": "Documentation",
+        "type": "page",
+        "href": "/docs"
+    }
+}