chore: add the documentation

Author: mobily

docs/.eslintrc.js

@@ -0,0 +1,22 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint', 'import', 'react'],
+  extends: ['plugin:react/recommended'],
+  settings: {
+    react: {
+      version: 'detect',
+    },
+  },
+  rules: {
+    'import/extensions': ['error', 'never'],
+    'no-shadow': 'off',
+    '@typescript-eslint/no-shadow': 'warn',
+    'linebreak-style': 'error',
+    'react/display-name': 'off',
+    'react/prop-types': 'off',
+    'react/react-in-jsx-scope': 'off',
+  },
+}

docs/.gitignore

@@ -0,0 +1,176 @@
+# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore
+
+# Logs
+
+logs
+_.log
+npm-debug.log_
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Caches 
+
+.cache
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# Runtime data
+
+pids
+_.pid
+_.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+
+lib-cov
+
+# Coverage directory used by tools like istanbul
+
+coverage
+*.lcov
+
+# nyc test coverage
+
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+
+bower_components
+
+# node-waf configuration
+
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+
+build/Release
+
+# Dependency directories
+
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+
+web_modules/
+
+# TypeScript cache
+
+*.tsbuildinfo
+
+# Optional npm cache directory
+
+.npm
+
+# Optional eslint cache
+
+.eslintcache
+
+# Optional stylelint cache
+
+.stylelintcache
+
+# Microbundle cache
+
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+
+.node_repl_history
+
+# Output of 'npm pack'
+
+*.tgz
+
+# Yarn Integrity file
+
+.yarn-integrity
+
+# dotenv environment variable files
+
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+
+.parcel-cache
+
+# Next.js build output
+
+.next
+out
+
+# Nuxt.js build / generate output
+
+.nuxt
+dist
+
+# Gatsby files
+
+# Comment in the public line in if your project uses Gatsby and not Next.js
+
+# https://nextjs.org/blog/next-9-1#public-directory-support
+
+# public
+
+# vuepress build output
+
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+
+.temp
+
+# Docusaurus cache and generated files
+
+.docusaurus
+
+# Serverless directories
+
+.serverless/
+
+# FuseBox cache
+
+.fusebox/
+
+# DynamoDB Local files
+
+.dynamodb/
+
+# TernJS port file
+
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+
+.vscode-test
+
+# yarn v2
+
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store
+.htaccess

docs/.prettierrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  parser: 'typescript',
+  semi: false,
+  singleQuote: true,
+  trailingComma: 'all',
+  printWidth: 100,
+  arrowParens: 'avoid',
+  endOfLine: 'auto',
+}

docs/bun.lockb

@@ -0,0 +1,83 @@
+.root {
+  margin: 0 auto;
+  max-width: 1208px;
+  padding-left: max(env(safe-area-inset-left), 1.5rem);
+  padding-right: max(env(safe-area-inset-right), 1.5rem);
+  border-top: 1px solid rgb(229, 231, 235);
+
+  :global(.dark) & {
+    border-top: 1px solid rgb(31, 31, 31);
+  }
+
+  h3 {
+    position: absolute;
+    left: 50%;
+    padding: 0 32px;
+    transform: translate(-50%, -50%);
+    text-transform: uppercase;
+    font-size: 24px;
+    letter-spacing: 0.1em;
+    font-weight: 400;
+    font-weight: 500;
+    color: hsl(204 12% 45%);
+    white-space: nowrap;
+    margin-top: 40px;
+
+    :global(.dark) & {
+      color: hsl(204, 8%, 50%);
+    }
+  }
+}
+
+.features {
+  padding: min(12vw, 6rem) 0;
+  display: grid;
+  grid-template-columns: repeat(1, 1fr);
+  place-items: start center;
+  row-gap: 40px;
+
+  @media (min-width: 640px) {
+    grid-template-columns: repeat(2, 1fr);
+  }
+
+  @media (min-width: 960px) {
+    grid-template-columns: repeat(3, 1fr);
+  }
+
+  li {
+    max-width: 300px;
+    color: hsl(204 12% 45%);
+
+    :global(.dark) & {
+      color: hsl(204, 8%, 50%);
+    }
+
+    @media (min-width: 640px) {
+      max-width: 256px;
+    }
+
+    svg {
+      display: inline;
+      margin-right: 2px;
+      transform: translate(0, -1px);
+    }
+
+    strong {
+      display: block;
+      font-weight: 400;
+      color: hsl(204 12% 5%);
+
+      @media (min-width: 640px) {
+        display: inline;
+
+        &::after {
+          content: '.';
+        }
+      }
+
+      :global(.dark) & {
+        color: hsl(204, 8%, 90%);
+      }
+    }
+  }
+}

docs/components/Features.module.css

@@ -0,0 +1,49 @@
+import { ReactNode } from 'react'
+import styles from './Features.module.css'
+
+export const Features = () => {
+  return (
+    <div className={styles.root}>
+      <h3>Key Features</h3>
+      <ul className={styles.features}>
+        <Feature
+          title="Reactive UI"
+          description="The library automatically handles UI updates based on input and events received."
+        />
+        <Feature
+          title="Flexbox"
+          description="NuiComponents supports a simple flexbox layout system, which provides a more flexible way to layout UIs."
+        />
+        <Feature
+          title="State Management"
+          description="The library provides a state management system that allows managing data and UI state with ease."
+        />
+
+        <Feature
+          title="Extensibility"
+          description="Create your custom components by using Component API."
+        />
+        <Feature
+          title="Reusability"
+          description="Reuse components between different parts of UI, reduce the amount of code you need to write."
+        />
+      </ul>
+    </div>
+  )
+}
+
+type FeatureProps = {
+  title: string
+  description: ReactNode
+  icon?: ReactNode
+}
+
+function Feature(props: FeatureProps) {
+  const { title, description, icon } = props
+
+  return (
+    <li>
+      <strong>{title}</strong> {description}
+    </li>
+  )
+}

docs/components/Features.tsx

@@ -0,0 +1,52 @@
+.root {
+  flex: 1;
+  font-size: 14px;
+  color: rgb(107, 114, 128);
+
+  :global(.dark) & {
+    color: rgba(156, 163, 175, var(--tw-text-opacity));
+  }
+
+  a {
+    color: rgb(107, 114, 128);
+    text-decoration: none;
+
+    :global(.dark) & {
+      color: rgba(156, 163, 175, var(--tw-text-opacity));
+    }
+
+    &:hover {
+      color: rgb(17, 24, 39);
+
+      :global(.dark) & {
+        color: rgb(249, 250, 251);
+      }
+    }
+  }
+}
+
+.columns {
+  margin-bottom: 2rem;
+  display: grid;
+  gap: 32px;
+  grid-template-columns: repeat(auto-fit, minmax(140px, 1fr));
+
+  h4 {
+    font-size: 18px;
+    letter-spacing: -1px !important;
+    font-family: 'Silkscreen', sans-serif;
+    text-transform: uppercase;
+    font-weight: normal !important;
+    margin-bottom: 20px;
+    line-height: 20px;
+
+    :global(.dark) & {
+      color: rgb(243, 244, 246);
+    }
+  }
+
+  li {
+    line-height: 21px;
+    margin-bottom: 12px;
+  }
+}