chore: base of new website documentation

WTTJ · Aug 2, 2023 · 6c9c0ed · 6c9c0ed
1 parent 29cdd2e
commit 6c9c0ed
Show file tree

Hide file tree

Showing 15 changed files with 3,223 additions and 0 deletions.
diff --git a/website/.eslintrc.json b/website/.eslintrc.json
@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}
diff --git a/website/.gitignore b/website/.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/website/README.md b/website/README.md
@@ -0,0 +1,34 @@
+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
+```
+
+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/website/app/design/[page]/page.tsx b/website/app/design/[page]/page.tsx
@@ -0,0 +1,17 @@
+import { Mdx } from '@/build-app/components/Mdx'
+import { getPageContent } from '@/build-app/utils/content'
+import { notFound } from 'next/navigation.js'
+
+type PageProps = {
+  params: {
+    page: string
+  }
+}
+
+export default function Page({ params }: PageProps) {
+  const { page } = params
+
+  const { content } = getPageContent(`design/${page}.md`)
+
+  return content === 'Not Found' ? notFound() : <Mdx>{content}</Mdx>
+}
diff --git a/website/app/docs/[category]/[page]/page.tsx b/website/app/docs/[category]/[page]/page.tsx
@@ -0,0 +1,3 @@
+export default function Page() {
+  return 'docs'
+}
diff --git a/website/app/layout.tsx b/website/app/layout.tsx
@@ -0,0 +1,18 @@
+import type { Metadata } from 'next'
+
+export const metadata: Metadata = {
+  title: 'Welcome UI - Customizable design system with react',
+  description:
+    'Here you’ll find all the core components you need to create a delightful webapp. Customizable design system from Welcome to the jungle with react, typescript, styled-components, ariakit and a lot of love 💛',
+}
+
+export default function RootLayout({ children }: { children: React.ReactNode }) {
+  return (
+    <html lang="en">
+      <head>
+        <link rel="icon" href="/favicon.png" type="image/png" sizes="32x32" />
+      </head>
+      <body>{children}</body>
+    </html>
+  )
+}
diff --git a/website/app/not-found.tsx b/website/app/not-found.tsx
@@ -0,0 +1,11 @@
+import Link from 'next/link'
+
+export default function NotFound() {
+  return (
+    <div>
+      <h2>Not Found</h2>
+      <p>Could not find requested resource</p>
+      <Link href="/">Return Home</Link>
+    </div>
+  )
+}
diff --git a/website/app/page.tsx b/website/app/page.tsx
@@ -0,0 +1,10 @@
+import Link from 'next/link'
+
+export default function Home() {
+  return (
+    <div style={{ display: 'grid', gap: 20 }}>
+      <Link href="/design">Design</Link>
+      <Link href="/docs">Docs (dev)</Link>
+    </div>
+  )
+}
diff --git a/website/build-app/components/Mdx/index.tsx b/website/build-app/components/Mdx/index.tsx
@@ -0,0 +1,8 @@
+import ReactMarkdown from 'react-markdown'
+import remarkGfm from 'remark-gfm'
+
+const markdown = `Just a link: https://reactjs.com.`
+
+export function Mdx({ children = markdown }) {
+  return <ReactMarkdown remarkPlugins={[remarkGfm]}>{children}</ReactMarkdown>
+}
diff --git a/website/build-app/utils/content.ts b/website/build-app/utils/content.ts
@@ -0,0 +1,21 @@
+import { existsSync, readFileSync } from 'fs'
+import { join } from 'path'
+import matter from 'gray-matter'
+
+/**
+ * Gets the content of md file
+ */
+export function getPageContent(filename: string) {
+  const file = join(process.cwd(), 'build-app', filename)
+
+  const fileExist = existsSync(file)
+
+  if (!fileExist) {
+    return { content: 'Not Found' }
+  } else {
+    const content = readFileSync(file, 'utf8')
+    const { content: contentWithoutMatter, data } = matter(content)
+
+    return { content, contentWithoutMatter, data }
+  }
+}
diff --git a/website/next.config.js b/website/next.config.js
@@ -0,0 +1,4 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {}
+
+module.exports = nextConfig
diff --git a/website/package.json b/website/package.json
@@ -0,0 +1,25 @@
+{
+  "name": "website",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "@types/node": "20.4.5",
+    "@types/react": "18.2.18",
+    "@types/react-dom": "18.2.7",
+    "eslint": "8.46.0",
+    "eslint-config-next": "13.4.12",
+    "gray-matter": "^4.0.3",
+    "next": "13.4.12",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "react-markdown": "^8.0.7",
+    "remark-gfm": "^3.0.1",
+    "typescript": "5.1.6"
+  }
+}
diff --git a/website/public/favicon.png b/website/public/favicon.png
diff --git a/website/tsconfig.json b/website/tsconfig.json
@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "incremental": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "exclude": ["node_modules"]
+}