@riebeckite/plugin-daily-notes 0.0.20 → 0.0.22

package/README.md

@@ -1,10 +1,12 @@
 # @riebeckite/plugin-daily-notes
 
+<!-- Generated from docs/docs/plugins/daily-notes.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
 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 +23,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 +38,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 +85,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 +102,4 @@ form while `DailyNote.dateDisplay` holds the formatted text.
 
 ## See also
 
-- [Plugin guide](../../../docs/docs/reference/plugin-api.md)
-
+- [Plugin guide](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.md)

package/README_ja.md

@@ -1,10 +1,12 @@
 # @riebeckite/plugin-daily-notes
 
+<!-- Generated from docs/docs/plugins/daily-notes.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
 デイリーノートから短いスニペットを取り出してサイトのウィジェットとして表示するプラグインです。
 
 [English](./README.md)
 
-## 概要
+## 推奨配置
 
 デイリーノートは、長い非公開の日記を 1 ファイルにまとめることが少なくありません。このプラグインは生のマニフェストを読み、指定ディレクトリ配下のノートを対象に、次の順番で最初に成功した方法からスニペットを 1 つだけ取り出します。
 
@@ -16,7 +18,9 @@
 
 `sourceUrl` と `sourceTitle` は `isPublished` が公開と判定したときだけ付きます。非公開ノートのパーマリンクとタイトルは `null` のままなので、置き場所が漏れることはありません。
 
-## 使い方
+`dailyNotesPlugin()` はデータとスタイルを登録しますが、ウィジェットを自動描画しません。配置は Site が所有し、ホームページのセクションが推奨位置です。
+
+## クイックスタート
 
 ```ts
 import { defineConfig } from "@riebeckite/core";
@@ -28,7 +32,7 @@ export default defineConfig({
 });
 ```
 
-### ウィジェットを置く
+ホームページ route または Site が所有するホームページセクションで明示的に描画します。
 
 ```tsx
 import DailyNotes, { getDailyNotes } from "@riebeckite/plugin-daily-notes";
@@ -64,6 +68,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 +82,4 @@ getDailyNotes({
 
 ## 関連資料
 
-- [プラグインシステム](../../../docs/docs/reference/plugin-api.ja.md)
-
+- [プラグインシステム](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.ja.md)

package/package.json

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