@levino/shipyard-docs 0.2.1 → 0.4.0

package/astro/DefaultLocaleDocsEntry.astro

@@ -0,0 +1,20 @@
+---
+import { getCollection, render } from 'astro:content'
+import Layout from './Layout.astro'
+
+export async function getStaticPaths() {
+  const docs = await getCollection('docs')
+
+  return docs.map((entry) => ({
+    params: { slug: entry.id },
+    props: { entry },
+  }))
+}
+// 2. For your template, you can get the entry directly from the prop
+const { entry } = Astro.props
+const { Content } = await render(entry)
+---
+
+<Layout>
+  <Content />
+</Layout>

package/astro/DocsEntry.astro

@@ -1,25 +1,25 @@
 ---
-import Layout from "./Layout.astro";
-import { getCollection, render } from "astro:content";
+import { getCollection, render } from 'astro:content'
+import Layout from './Layout.astro'
 
 export async function getStaticPaths() {
+  const docs = await getCollection('docs')
   const getParams = (slug: string) => {
-    const [locale, ...rest] = slug.split("/");
+    const [locale, ...rest] = slug.split('/')
     return {
-      slug: rest.length ? rest.join("/") : undefined,
+      slug: rest.length ? rest.join('/') : undefined,
       locale,
-    };
-  };
-  const docs = await getCollection("docs");
-
+    }
+  }
   return docs.map((entry) => ({
     params: getParams(entry.id),
     props: { entry },
-  }));
+  }))
 }
+
 // 2. For your template, you can get the entry directly from the prop
-const { entry } = Astro.props;
-const { Content } = await render(entry);
+const { entry } = Astro.props
+const { Content } = await render(entry)
 ---
 
 <Layout>

package/astro/Layout.astro

@@ -1,43 +1,44 @@
 ---
-import { getCollection, render } from "astro:content";
-import BaseLayout from "@levino/shipyard-base/layouts/Page.astro";
-import { toSidebarEntries } from "../src/sidebarEntries";
-import { path } from "ramda";
-import type { NavigationTree } from "@levino/shipyard-base";
-import { Array, Option } from "effect";
+import { getCollection, render } from 'astro:content'
+import type { NavigationTree } from '@levino/shipyard-base'
+import BaseLayout from '@levino/shipyard-base/layouts/Page.astro'
+import { Array as EffectArray, Option } from 'effect'
+import { path } from 'ramda'
+import { toSidebarEntries } from '../src/sidebarEntries'
 
-const locale = Astro.currentLocale as string;
-const docs = await getCollection("docs")
+const getPath = (id: string) => `/${Astro.currentLocale}/docs/${id.slice(3)}`
+
+const docs = await getCollection('docs')
   .then(
-    Array.map(async (doc) => {
+    EffectArray.map(async (doc) => {
       const {
         id,
         data: {
           title,
           sidebar: { render: shouldBeRendered, label },
         },
-      } = doc;
+      } = doc
       return {
-        path: `/${locale}/docs/${id.slice(3)}`,
+        path: getPath(id),
         title:
           label ??
           title ??
           Option.getOrUndefined(
-            Array.findFirst(
+            EffectArray.findFirst(
               (await render(doc)).headings,
               ({ depth }) => depth === 1,
             ),
           )?.text ??
           id,
         link: shouldBeRendered,
-      };
+      }
     }),
   )
-  .then(Promise.all.bind(Promise));
+  .then((promises) => Promise.all(promises))
 
-const entries = path([locale, "subEntry", "docs", "subEntry"])(
+const entries = path([Astro.currentLocale, 'subEntry', 'docs', 'subEntry'])(
   toSidebarEntries(docs),
-) as NavigationTree;
+) as NavigationTree
 ---
 
 <BaseLayout sidebarNavigation={entries}>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@levino/shipyard-docs",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "",
   "type": "module",
   "main": "src/index.ts",
@@ -13,7 +13,7 @@
   "dependencies": {
     "effect": "^3.12.5",
     "ramda": "^0.29.1",
-    "@levino/shipyard-base": "^0.3.0"
+    "@levino/shipyard-base": "^0.5.0"
   },
   "devDependencies": {
     "@tailwindcss/typography": "^0.5.16",

package/src/sidebarEntries.test.ts

@@ -1,5 +1,6 @@
 import { describe, expect, test } from 'vitest'
 import { toSidebarEntries } from './sidebarEntries'
+
 describe('Sidebar subEntry helpers', () => {
   test.each([
     [

package/src/sidebarEntries.ts

@@ -1,5 +1,6 @@
 import type { Entry } from '@levino/shipyard-base'
 import { mergeDeepLeft } from 'ramda'
+
 interface DocsData {
   title: string
   path: string