chore: docs readme updated and restructured (#7)

* chore: docs readme updated and restructured * chore: more modification * chore: removed docs/doc folder * chore: ignored docs/doc folder
rjoydip · Sep 7, 2024 · aa5b9d9 · aa5b9d9
1 parent c5ce107
commit aa5b9d9
Show file tree

Hide file tree

Showing 47 changed files with 899 additions and 151 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -60,7 +60,7 @@ jobs:
         run: npm install -g yarn
 
       - name: 🧹 Cleanup
-        run: deno run --allow-read --allow-write scripts/clean/docs.ts
+        run: deno run --allow-read --allow-write scripts/doc/clean.ts
 
       - name: ⏳ Run Install
         run: deno run --allow-read --allow-env --allow-run scripts/run/install.ts
@@ -78,7 +78,9 @@ jobs:
         run: deno run --allow-read --allow-env --allow-run scripts/run/test.ts
 
       - name: 📜 Generate Docs
-        run: deno run --allow-read --allow-env --allow-run scripts/gen/doc.ts
+        run: |
+          deno run --allow-read --allow-env --allow-run scripts/doc/gen.ts
+          deno run --allow-read --allow-write scripts/doc/for-docs.ts
 
   build:
     name: 🏗️ Build

diff --git a/.gitignore b/.gitignore
@@ -180,4 +180,5 @@ _cache
 
 # Custom
 apps/**/docs
-scripts/docs
+scripts/docs
+docs/doc
diff --git a/apps/deno/std/.gitkeep b/apps/deno/std/.gitkeep
diff --git a/apps/hono/discord/runtime-bun/1276209554279108745/readme.md b/apps/hono/discord/runtime-bun/1276209554279108745/readme.md
@@ -1,6 +1,18 @@
+---
+title: 'Hono Discord Problem 1276209554279108745'
+layout: ''
+---
+
 # @hono/discord/problem-1276209554279108745
 
-Provided solution here [https://discord.com/channels/1011308539819597844/1276209554279108745/1276928165155180565](https://discord.com/channels/1011308539819597844/1276209554279108745/1276928165155180565)
+Provided solution here <https://discord.com/channels/1011308539819597844/1276209554279108745/1276928165155180565>
+
+## Contents
+
+* [Solution](#solution)
+* [Setup](#setup)
+
+## Solution
 
 Without Promise
 

diff --git a/apps/hono/discord/runtime-deno/1275791703797927959/readme.md b/apps/hono/discord/runtime-deno/1275791703797927959/readme.md
@@ -1,13 +1,23 @@
+---
+title: 'Hono Discord Problem 1275791703797927959'
+layout: ''
+---
+
 # @hono/discord/problem-1275791703797927959
 
-[https://discord.com/channels/1011308539819597844/1275791703797927959](https://discord.com/channels/1011308539819597844/1275791703797927959)
+<https://discord.com/channels/1011308539819597844/1275791703797927959>
+
+## Contents
+
+* [Solution](#solution)
+* [Setup](#setup)
 
 ## Solution
 
 It's possiable to send a Blob on the body.
 
 Provided solution here
-[https://discord.com/channels/1011308539819597844/1275791703797927959/1277320939780178124](https://discord.com/channels/1011308539819597844/1275791703797927959/1277320939780178124)
+<https://discord.com/channels/1011308539819597844/1275791703797927959/1277320939780178124>
 
 ## Setup
 

diff --git a/apps/hono/discord/runtime-deno/1276699964776513628/readme.md b/apps/hono/discord/runtime-deno/1276699964776513628/readme.md
@@ -1,11 +1,21 @@
+---
+title: 'Hono Discord Problem 1276699964776513628'
+layout: ''
+---
+
 # @hono/discord/problem-1276699964776513628
 
-[https://discord.com/channels/1011308539819597844/1276699964776513628](https://discord.com/channels/1011308539819597844/1276699964776513628)
+<https://discord.com/channels/1011308539819597844/1276699964776513628>
+
+## Contents
+
+* [Solution](#solution)
+* [Setup](#setup)
 
 ## Solution
 
 Provided solution here
-[https://discord.com/channels/1011308539819597844/1276699964776513628/1277141663612928052](https://discord.com/channels/1011308539819597844/1276699964776513628/1277141663612928052)
+<https://discord.com/channels/1011308539819597844/1276699964776513628/1277141663612928052>
 
 ```ts
 import { Hono, TypedResponse } from "hono";

diff --git a/apps/hono/github/runtime-bun/3242/readme.md b/apps/hono/github/runtime-bun/3242/readme.md
@@ -1,11 +1,21 @@
+---
+title: 'Hono Github Issue 3242'
+layout: ''
+---
+
 # @hono/github/issue-3242
 
-[https://github.com/honojs/hono/issue/3242](https://github.com/honojs/hono/issue/3242)
+<https://github.com/honojs/hono/issue/3242>
+
+## Contents
+
+* [Solution](#solution)
+* [Setup](#setup)
 
 ## Solution
 
 Please check
-[https://github.com/honojs/hono/issue/3242#issuecomment-2275418065](https://github.com/honojs/hono/issue/3242#issuecomment-2275418065)
+<https://github.com/honojs/hono/issue/3242#issuecomment-2275418065>
 of solution being provided.
 
 > **Not working**

diff --git a/apps/hono/github/runtime-bun/3271/readme.md b/apps/hono/github/runtime-bun/3271/readme.md
@@ -1,11 +1,21 @@
+---
+title: 'Hono Github Issue 3271'
+layout: ''
+---
+
 # @hono/github/issue-3271
 
-[https://github.com/honojs/hono/issue/3271](https://github.com/honojs/hono/issue/3271)
+<https://github.com/honojs/hono/issue/3271>
+
+## Contents
+
+* [Solution](#solution)
+* [Setup](#setup)
 
 ## Solution
 
 Please check
-[https://github.com/honojs/hono/issues/3271#issuecomment-2302675787](https://github.com/honojs/hono/issues/3271#issuecomment-2302675787)
+<https://github.com/honojs/hono/issues/3271#issuecomment-2302675787>
 of solution being provided.
 
 > **Not working**

diff --git a/apps/hono/github/runtime-deno/3238/readme.md b/apps/hono/github/runtime-deno/3238/readme.md
@@ -1,11 +1,21 @@
+---
+title: 'Hono Github Issue 3238'
+layout: ''
+---
+
 # @hono/github/issue-3238
 
-[https://github.com/honojs/hono/3238](https://github.com/honojs/hono/3238)
+<https://github.com/honojs/hono/3238>
+
+## Contents
+
+* [Solution](#solution)
+* [Setup](#setup)
 
 ## Solution
 
 Provided solution here
-[https://github.com/honojs/hono/3238#issuecomment-2278379005](https://github.com/honojs/hono/3238#issuecomment-2278379005)
+<https://github.com/honojs/hono/3238#issuecomment-2278379005>
 
 ```diff
 app.use(

diff --git a/apps/hono/github/runtime-deno/3254/readme.md b/apps/hono/github/runtime-deno/3254/readme.md
@@ -1,6 +1,16 @@
+---
+title: 'Hono Github Issue 3254'
+layout: ''
+---
+
 # @hono/github/issue-3254
 
-[https://github.com/honojs/hono/3254](https://github.com/honojs/hono/3254)
+<https://github.com/honojs/hono/3254>
+
+## Contents
+
+* [Solution](#solution)
+* [Setup](#setup)
 
 ## Solution
 

diff --git a/apps/hono/github/runtime-node/3275/client/README.md b/apps/hono/github/runtime-node/3275/client/README.md
@@ -1,12 +1,23 @@
+---
+title: 'Hono Github Issue 3275 - Client'
+layout: ''
+---
+
 # create-svelte
 
 Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
 
+## Contents
+
+* [Creating a project](#creating-a-project)
+* [Developing](#developing)
+* [Building](#building)
+
 ## Creating a project
 
 If you're seeing this, you've probably already done this step. Congrats!
 
-```bash
+```sh
 # create a new project in the current directory
 npm create svelte@latest
 
@@ -18,7 +29,7 @@ npm create svelte@latest my-app
 
 Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
 
-```bash
+```sh
 npm run dev
 
 # or start the server and open the app in a new browser tab
@@ -29,7 +40,7 @@ npm run dev -- --open
 
 To create a production version of your app:
 
-```bash
+```sh
 npm run build
 ```
 

diff --git a/apps/hono/github/runtime-node/3275/readme.md b/apps/hono/github/runtime-node/3275/readme.md
@@ -1,13 +1,23 @@
+---
+title: 'Hono Github Issue 3275'
+layout: ''
+---
+
 # @hono/github/issue-3275
 
-[https://github.com/honojs/hono/3275](https://github.com/honojs/hono/3275)
+<https://github.com/honojs/hono/3275>
+
+## Contents
+
+* [Solution](#solution)
+* [Setup](#setup)
 
 ## Solution
 
 Provided solution here
-[https://github.com/honojs/hono/issues/3275#issuecomment-2294830487](https://github.com/honojs/hono/issues/3275#issuecomment-2294830487)
+<https://github.com/honojs/hono/issues/3275#issuecomment-2294830487>
 
-Actual typo is [https://github.com/honojs/hono/issues/3275#issuecomment-2295853901](https://github.com/honojs/hono/issues/3275#issuecomment-2295853901)
+Actual typo is <https://github.com/honojs/hono/issues/3275#issuecomment-2295853901>
 
 ```ts
 define: {

diff --git a/apps/hono/github/runtime-node/3275/server/README.md b/apps/hono/github/runtime-node/3275/server/README.md
@@ -1,3 +1,8 @@
+---
+title: 'Hono Github Issue 3275 - Server'
+layout: ''
+---
+
 ```
 npm install
 npm run start

diff --git a/apps/neverthrow/runtime-deno/564/readme.md b/apps/neverthrow/runtime-deno/564/readme.md
@@ -1,8 +1,18 @@
+---
+title: 'Neverthrow Issue 564'
+layout: ''
+---
+
 # neverthrow/issue-564
 
-[https://github.com/honojs/neverthrow/564](https://github.com/honojs/neverthrow/564)
+<https://github.com/honojs/neverthrow/564>
+
+## Contents
+
+* [Solution](#solution)
+* [Setup](#setup)
 
-## Comment
+## Solution
 
 Provided comment here
 [564#issuecomment-2297137078](https://github.com/supermacro/neverthrow/issues/564#issuecomment-2297137078)

diff --git a/docs/_config.ts b/docs/_config.ts
@@ -10,12 +10,9 @@ import postcss from "lume/plugins/postcss.ts";
 import nesting from "npm:postcss-nesting";
 import sitemap from "lume/plugins/sitemap.ts";
 import metas from "lume/plugins/metas.ts";
-import toc from "lume_markdown_plugins/toc.ts";
-import { alert } from "npm:@mdit/plugin-alert";
 import ventoLang from "vento/highlightjs-vento.js";
 
 const markdown = {
-  plugins: [toc, alert],
   options: {
     linkify: true,
   },
@@ -29,9 +26,7 @@ const site = lume(
 );
 
 site
-  .ignore("scripts")
   .copy("static", ".")
-  .use(toc())
   .use(codeHighlight({
     languages: {
       vento: ventoLang,

diff --git a/docs/_includes/layouts/base.vto b/docs/_includes/layouts/base.vto
@@ -43,7 +43,7 @@
       <link rel="stylesheet" href="/styles/pages/{{ page_css }}">
     {{ /if }}
 
-    <script src="/main.js" type="module"></script>
+    <script src="/custom/inject.js" type="module"></script>
   </head>
   <body>
     {{ include "templates/navbar.vto" }}
@@ -63,6 +63,7 @@
         mediaMatch(mediaQuery).addEventListener("change", (event) => {
           storeTheme(event.matches);
         });
+      });
     </script>
   </body>
 </html>
diff --git a/docs/_includes/layouts/landing.vto b/docs/_includes/layouts/landing.vto
@@ -107,7 +107,7 @@ page_css: landing.css
     bottom: 0;
     width: 5em;
     height: 5em;
-    animation-name: firecircle;
+    animation-name: langCircle;
     will-change: transform;
   }
   .badge::after {
@@ -165,7 +165,7 @@ page_css: landing.css
       margin-left: 2.8em;
       margin-bottom: 1.1em;
   }
-  @keyframes firecircle {
+  @keyframes langCircle {
     0% {
       transform: translateY(0) scale(1);
     }

diff --git a/docs/_includes/styles/components/navbar.css b/docs/_includes/styles/components/navbar.css
@@ -132,18 +132,6 @@
           }
         }
       }
-
-      @media (max-width: 768px) {
-        .navbar-search {
-          min-width: auto;
-          min-height: auto;
-        }
-
-        .DocSearch-Container {
-          position: fixed !important;
-          /* This overrides the docsearch modal `position: absolute`, fixes position issue on chrome (mobile) */
-        }
-      }
     }
   }
 }
diff --git a/docs/_includes/styles/components/toc.css b/docs/_includes/styles/components/toc.css