Merge branch 'feature/add-doc' into develop

mnfst · May 15, 2024 · 3f8ae28 · 3f8ae28
2 parents de8cee4 + dd023d7
commit 3f8ae28
Show file tree

Hide file tree

Showing 4 changed files with 200 additions and 0 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
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/index.html b/docs/index.html
@@ -0,0 +1,153 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>CASE Documentation</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta name="description" content="Description" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
+    />
+    <link
+      rel="stylesheet"
+      href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"
+    />
+    <link rel="icon" type="image/x-icon" href="assets/images/favicon.png" />
+  </head>
+  <body>
+    <nav>
+      <a
+        href="https://github.com/casejs/CASE"
+        rel="noopener noreferrer"
+        target="_blank"
+        >Github</a
+      >
+      <a
+        href="https://discord.gg/FepAked3W7"
+        rel="noopener noreferrer"
+        target="_blank"
+        >Discord</a
+      >
+    </nav>
+    <div id="app"></div>
+    <style>
+      .is-ib {
+        display: inline-block;
+      }
+      .is-ib img {
+        display: block;
+      }
+      .markdown-section {
+        max-width: 80%;
+        font-size: 17px;
+      }
+      @media screen and (min-width: 1480px) {
+        .markdown-section {
+          max-width: 1140px;
+        }
+      }
+
+      .pagination-item {
+        padding: 1rem;
+        border: 1px solid rgba(0, 0, 0, 0.07);
+        border-radius: 4px;
+      }
+      .pagination-item:hover {
+        border: 1px solid rgba(0, 0, 0, 0.27);
+      }
+
+      .markdown-section pre,
+      .markdown-section pre > code {
+        background-color: #1e2432;
+        color: #fefeff;
+      }
+      .markdown-section .token.comment {
+        color: #c2e588;
+      }
+      .markdown-section .token.punctuation {
+        color: #fefeff;
+      }
+      .is-bordered {
+        border: 1px solid rgba(0, 0, 0, 0.07);
+      }
+      h2 {
+        padding-bottom: 0.4rem;
+        border-bottom: 1px solid #eaeaef;
+      }
+      img.has-shadow {
+        margin: 1.5rem 3rem 3rem;
+        border: 1px solid rgba(0, 0, 0, 0.07);
+        box-shadow: 0px 82px 33px rgba(59, 59, 59, 0.01),
+          0px 46px 28px rgba(59, 59, 59, 0.05),
+          0px 20px 20px rgba(59, 59, 59, 0.09),
+          0px 5px 11px rgba(59, 59, 59, 0.1), 0px 0px 0px rgba(59, 59, 59, 0.1);
+        width: calc(100% - 6rem);
+      }
+
+      .is-flex {
+        display: flex;
+      }
+      .is-align-items-center {
+        align-items: center;
+      }
+      .is-justify-content-center {
+        justify-content: center;
+      }
+      .yield,
+      .field {
+        height: 100%;
+        width: 50%;
+      }
+      .is-hidden-tablet {
+        @media screen and (max-width: 768px) {
+          display: none;
+        }
+      }
+      .is-hidden-desktop {
+        @media screen and (min-width: 769px) {
+          display: none;
+        }
+      }
+      .show-result img {
+        width: 100%;
+      }
+      .beta-feature {
+        padding: 10px;
+        background-color: yellow;
+        border-left: 5px solid orange;
+        margin: 10px 0;
+      }
+    </style>
+
+    <script>
+      window.$docsify = {
+        routerMode: 'history',
+        homepage: 'introduction.md',
+        loadSidebar: true,
+        subMaxLevel: 3,
+        auto2top: true,
+        name: 'CASE Documentation',
+        relativePath: true,
+        repo: '',
+        copyCode: {
+          buttonText: 'Copy to clipboard',
+          errorText: 'Error',
+          successText: 'Copied'
+        }
+      }
+    </script>
+    <!-- Docsify v4 -->
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/docsify/4.4.1/docsify.js"></script>
+    <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+
+    <!-- Plugins: https://github.com/fzankl/docsify-plugin-flexible-alerts -->
+    <script src="https://unpkg.com/docsify-plugin-flexible-alerts"></script>
+
+    <!-- Plugins: https://github.com/imyelo/docsify-pagination -->
+    <script src="//unpkg.com/docsify-pagination/dist/docsify-pagination.min.js"></script>
+
+    <!-- Latest v2.1.1 -->
+    <script src="https://unpkg.com/docsify-copy-code@2"></script>
+  </body>
+</html>
diff --git a/vercel.json b/vercel.json
@@ -0,0 +1,11 @@
+{
+  "rewrites": [{ "source": "/docs/(.*)", "destination": "/docs/index.html" }],
+  "routes": [
+    {
+      "src": "/docs/(.*)",
+      "headers": { "Cache-Control": "no-cache" },
+      "continue": true
+    }
+  ],
+  "cleanUrls": true
+}