@riebeckite/plugin-daily-notes 0.0.19 → 0.0.21

package/README.md

@@ -4,7 +4,7 @@ Surfaces short snippets extracted from Daily Notes as a site widget.
 
 [日本語](./README_ja.md)
 
-## Overview
+## Recommended placement
 
 A Daily Note is often one long, private journal file. This plugin reads the raw
 manifest, picks notes under a configured directory, and extracts exactly one
@@ -21,7 +21,10 @@ wholesale, so a long private note only contributes the snippet that opted in.
 note. An unpublished note's permalink and title stay `null`, so private notes
 never leak their location.
 
-## Usage
+`dailyNotesPlugin()` registers data and styles but does not render the widget.
+The Site owns placement; a homepage section is the recommended location.
+
+## Quick Start
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
@@ -33,7 +36,7 @@ export default defineConfig({
 });
 ```
 
-### Render the widget
+Render the widget explicitly in a homepage route or site-owned homepage section:
 
 ```tsx
 import DailyNotes, { getDailyNotes } from "@riebeckite/plugin-daily-notes";
@@ -80,6 +83,9 @@ guessing another one.
 `<time datetime>` attribute regardless, and `DailyNote.date` keeps that ISO
 form while `DailyNote.dateDisplay` holds the formatted text.
 
+Move or remove the `DailyNotes` element to reposition or remove the widget. No
+official Starter renders Daily Notes by default.
+
 ## Exports
 
 - `dailyNotesPlugin(options?)` — plugin factory (registers `style.css`)
@@ -94,5 +100,4 @@ form while `DailyNote.dateDisplay` holds the formatted text.
 
 ## See also
 
-- [Plugin guide](../../../docs/docs/reference/plugin-api.en.md)
-
+- [Plugin guide](../../../docs/docs/reference/plugin-api.md)

package/README_ja.md

@@ -4,7 +4,7 @@
 
 [English](./README.md)
 
-## 概要
+## 推奨配置
 
 デイリーノートは、長い非公開の日記を 1 ファイルにまとめることが少なくありません。このプラグインは生のマニフェストを読み、指定ディレクトリ配下のノートを対象に、次の順番で最初に成功した方法からスニペットを 1 つだけ取り出します。
 
@@ -16,7 +16,9 @@
 
 `sourceUrl` と `sourceTitle` は `isPublished` が公開と判定したときだけ付きます。非公開ノートのパーマリンクとタイトルは `null` のままなので、置き場所が漏れることはありません。
 
-## 使い方
+`dailyNotesPlugin()` はデータとスタイルを登録しますが、ウィジェットを自動描画しません。配置は Site が所有し、ホームページのセクションが推奨位置です。
+
+## クイックスタート
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
@@ -28,7 +30,7 @@ export default defineConfig({
 });
 ```
 
-### ウィジェットを置く
+ホームページ route または Site が所有するホームページセクションで明示的に描画します。
 
 ```tsx
 import DailyNotes, { getDailyNotes } from "@riebeckite/plugin-daily-notes";
@@ -64,6 +66,8 @@ getDailyNotes({
 
 `dateFormat` はウィジェットの日付表示を決めます。既定は `"iso"`（`YYYY-MM-DD`）で、ほかに `"long"` と `"short"` があります。`"long"` と `"short"` は `locale`（既定 `"en"`）で整形します。機械可読な `YYYY-MM-DD` は常に `<time datetime>` 属性に残り、`DailyNote.date` はその ISO 形式のまま、`DailyNote.dateDisplay` に整形後の文字列が入ります。
 
+位置を変える・消すときは `DailyNotes` 要素を移動・削除します。公式 Starter は Daily Notes を既定で描画しません。
+
 ## 主なエクスポート
 
 - `dailyNotesPlugin(options?)`: プラグインを作る（`style.css` を登録する）
@@ -76,5 +80,4 @@ getDailyNotes({
 
 ## 関連資料
 
-- [プラグインシステム](../../../docs/docs/reference/plugin-api.md)
-
+- [プラグインシステム](../../../docs/docs/reference/plugin-api.ja.md)

package/dist/components/daily-notes.js

@@ -5,26 +5,19 @@ function DailyNotes(props) {
   const limit = props.limit ?? DEFAULT_LIMIT;
   const notes = props.notes.slice(0, Math.max(0, limit));
   if (notes.length === 0) return null;
-  return /* @__PURE__ */ jsxs(
-    "section",
-    {
-      class: "daily-notes rr-daily-notes",
-      "aria-labelledby": "daily-notes-title",
-      children: [
-        /* @__PURE__ */ jsxs("div", { class: "daily-notes__header", children: [
-          /* @__PURE__ */ jsx("p", { class: "daily-notes__eyebrow", children: "DAILY NOTES" }),
-          /* @__PURE__ */ jsx("h2", { class: "daily-notes__title", id: "daily-notes-title", children: "Recent Daily Notes" })
-        ] }),
-        /* @__PURE__ */ jsx("ul", { class: "daily-notes__list", children: notes.map((note) => /* @__PURE__ */ jsxs("li", { class: "daily-notes__item", children: [
-          /* @__PURE__ */ jsxs("div", { class: "daily-notes__meta", children: [
-            note.date.length > 0 ? /* @__PURE__ */ jsx("time", { class: "daily-notes__date", dateTime: note.date, children: note.dateDisplay }) : null,
-            note.sourceUrl !== null ? /* @__PURE__ */ jsx("a", { class: "daily-notes__source", href: note.sourceUrl, children: resolveSourceLabel(note) }) : null
-          ] }),
-          /* @__PURE__ */ jsx("p", { class: "daily-notes__snippet", children: note.snippet })
-        ] }, note.slug)) })
-      ]
-    }
-  );
+  return /* @__PURE__ */ jsxs("section", { class: "rr-daily-notes", "aria-labelledby": "daily-notes-title", children: [
+    /* @__PURE__ */ jsxs("div", { class: "rr-daily-notes__header", children: [
+      /* @__PURE__ */ jsx("p", { class: "rr-daily-notes__eyebrow", children: "DAILY NOTES" }),
+      /* @__PURE__ */ jsx("h2", { class: "rr-daily-notes__title", id: "daily-notes-title", children: "Recent Daily Notes" })
+    ] }),
+    /* @__PURE__ */ jsx("ul", { class: "rr-daily-notes__list", children: notes.map((note) => /* @__PURE__ */ jsxs("li", { class: "rr-daily-notes__item", children: [
+      /* @__PURE__ */ jsxs("div", { class: "rr-daily-notes__meta", children: [
+        note.date.length > 0 ? /* @__PURE__ */ jsx("time", { class: "rr-daily-notes__date", dateTime: note.date, children: note.dateDisplay }) : null,
+        note.sourceUrl !== null ? /* @__PURE__ */ jsx("a", { class: "rr-daily-notes__source", href: note.sourceUrl, children: resolveSourceLabel(note) }) : null
+      ] }),
+      /* @__PURE__ */ jsx("p", { class: "rr-daily-notes__snippet", children: note.snippet })
+    ] }, note.slug)) })
+  ] });
 }
 function resolveSourceLabel(note) {
   if (note.sourceTitle !== null && note.sourceTitle.length > 0) {

package/dist/index.js

@@ -304,26 +304,19 @@ function DailyNotes(props) {
   const limit = props.limit ?? DEFAULT_LIMIT2;
   const notes = props.notes.slice(0, Math.max(0, limit));
   if (notes.length === 0) return null;
-  return /* @__PURE__ */ jsxs(
-    "section",
-    {
-      class: "daily-notes rr-daily-notes",
-      "aria-labelledby": "daily-notes-title",
-      children: [
-        /* @__PURE__ */ jsxs("div", { class: "daily-notes__header", children: [
-          /* @__PURE__ */ jsx("p", { class: "daily-notes__eyebrow", children: "DAILY NOTES" }),
-          /* @__PURE__ */ jsx("h2", { class: "daily-notes__title", id: "daily-notes-title", children: "Recent Daily Notes" })
-        ] }),
-        /* @__PURE__ */ jsx("ul", { class: "daily-notes__list", children: notes.map((note) => /* @__PURE__ */ jsxs("li", { class: "daily-notes__item", children: [
-          /* @__PURE__ */ jsxs("div", { class: "daily-notes__meta", children: [
-            note.date.length > 0 ? /* @__PURE__ */ jsx("time", { class: "daily-notes__date", dateTime: note.date, children: note.dateDisplay }) : null,
-            note.sourceUrl !== null ? /* @__PURE__ */ jsx("a", { class: "daily-notes__source", href: note.sourceUrl, children: resolveSourceLabel(note) }) : null
-          ] }),
-          /* @__PURE__ */ jsx("p", { class: "daily-notes__snippet", children: note.snippet })
-        ] }, note.slug)) })
-      ]
-    }
-  );
+  return /* @__PURE__ */ jsxs("section", { class: "rr-daily-notes", "aria-labelledby": "daily-notes-title", children: [
+    /* @__PURE__ */ jsxs("div", { class: "rr-daily-notes__header", children: [
+      /* @__PURE__ */ jsx("p", { class: "rr-daily-notes__eyebrow", children: "DAILY NOTES" }),
+      /* @__PURE__ */ jsx("h2", { class: "rr-daily-notes__title", id: "daily-notes-title", children: "Recent Daily Notes" })
+    ] }),
+    /* @__PURE__ */ jsx("ul", { class: "rr-daily-notes__list", children: notes.map((note) => /* @__PURE__ */ jsxs("li", { class: "rr-daily-notes__item", children: [
+      /* @__PURE__ */ jsxs("div", { class: "rr-daily-notes__meta", children: [
+        note.date.length > 0 ? /* @__PURE__ */ jsx("time", { class: "rr-daily-notes__date", dateTime: note.date, children: note.dateDisplay }) : null,
+        note.sourceUrl !== null ? /* @__PURE__ */ jsx("a", { class: "rr-daily-notes__source", href: note.sourceUrl, children: resolveSourceLabel(note) }) : null
+      ] }),
+      /* @__PURE__ */ jsx("p", { class: "rr-daily-notes__snippet", children: note.snippet })
+    ] }, note.slug)) })
+  ] });
 }
 function resolveSourceLabel(note) {
   if (note.sourceTitle !== null && note.sourceTitle.length > 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-daily-notes",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -22,7 +22,7 @@
   },
   "dependencies": {
     "hono": "^4.12.25",
-    "@riebeckite/core": "0.0.19"
+    "@riebeckite/core": "0.0.21"
   },
   "devDependencies": {
     "tsx": "^4.22.4"

package/style.css

@@ -1,17 +1,17 @@
 @layer components {
-  .daily-notes {
+  .rr-daily-notes {
     margin-top: 4rem;
     padding-top: 1.5rem;
     border-top: 1px solid color-mix(in srgb, currentColor 18%, transparent);
   }
 
-  .daily-notes__header {
+  .rr-daily-notes__header {
     display: grid;
     gap: 0.25rem;
     margin-bottom: 1.25rem;
   }
 
-  .daily-notes__eyebrow {
+  .rr-daily-notes__eyebrow {
     margin: 0;
     font-size: 0.75rem;
     font-weight: 700;
@@ -19,14 +19,14 @@
     color: color-mix(in srgb, currentColor 54%, transparent);
   }
 
-  .daily-notes__title {
+  .rr-daily-notes__title {
     margin: 0;
     font-size: clamp(1.5rem, 4vw, 2rem);
     line-height: 1.2;
     letter-spacing: -0.02em;
   }
 
-  .daily-notes__list {
+  .rr-daily-notes__list {
     display: grid;
     gap: 1.25rem;
     margin: 0;
@@ -34,13 +34,13 @@
     list-style: none;
   }
 
-  .daily-notes__item {
+  .rr-daily-notes__item {
     margin: 0;
     padding: 1rem 0 0;
     border-top: 1px solid color-mix(in srgb, currentColor 14%, transparent);
   }
 
-  .daily-notes__meta {
+  .rr-daily-notes__meta {
     display: flex;
     flex-wrap: wrap;
     gap: 0.75rem;
@@ -48,26 +48,26 @@
     margin-bottom: 0.5rem;
   }
 
-  .daily-notes__date {
+  .rr-daily-notes__date {
     font-size: 0.75rem;
     font-weight: 700;
     letter-spacing: 0.08em;
     color: color-mix(in srgb, currentColor 62%, transparent);
   }
 
-  .daily-notes__source {
+  .rr-daily-notes__source {
     font-size: 0.75rem;
     color: var(--rb-color-accent, currentColor);
     text-decoration: underline;
     text-underline-offset: 0.2em;
   }
 
-  .daily-notes__source:focus-visible {
+  .rr-daily-notes__source:focus-visible {
     outline: 2px solid var(--rb-color-accent, currentColor);
     outline-offset: 3px;
   }
 
-  .daily-notes__snippet {
+  .rr-daily-notes__snippet {
     margin: 0;
     font-size: 1rem;
     line-height: 1.75;