@riebeckite/plugin-docs 0.0.0-stage → 0.0.23

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Rerurate_514
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,88 @@
-# Temporary Holding Version
+# @riebeckite/plugin-docs
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<!-- Generated from docs/docs/plugins/docs.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
+Build-time docs navigation for Riebeckite. The plugin creates a sidebar and
+previous/next links from a published Markdown subtree without adding a docs
+router or recalculating public URLs from filesystem paths.
+
+[日本語](./README_ja.md)
+
+## Installation
+
+```sh
+pnpm add @riebeckite/plugin-docs
+```
+
+## Basic usage
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { docs } from "@riebeckite/plugin-docs";
+
+export default defineConfig({
+  plugins: [
+    docs({
+      root: "docs",
+      sidebar: { auto: true },
+      prevNext: true,
+    }),
+  ],
+});
+```
+
+`root` is the content subtree to treat as docs. With `root: "docs"`, only
+content below `content/docs/` is included; notes and blog posts outside that
+subtree are left unchanged.
+
+## Frontmatter
+
+```yaml
+---
+title: Installation
+sidebar:
+  label: Install
+  order: 2
+  hidden: false
+  collapsed: false
+---
+```
+
+Supported sidebar metadata:
+
+- `label` — label shown in navigation. Falls back to `title`, then filename.
+- `order` — explicit deterministic order. Missing values sort after ordered
+  items by title and path.
+- `hidden` — removes the page from sidebar and previous/next navigation.
+- `collapsed` — exposes collapsed state through `data-docs-collapsed` for theme
+  or client enhancement.
+
+All fields are optional. A page without `sidebar` frontmatter still appears in
+the navigation: the hierarchy follows the folder structure, the label falls back
+to `title`, and the order is title-based. `sidebar` is a Riebeckite extension, so
+it lives with the content rather than in the site configuration. Add only the
+fields you want to override and leave the rest of the vault untouched.
+
+## Output and theme integration
+
+The plugin provides React-like JSX components for site integration:
+
+## l10n and publishing
+
+When localization metadata from `@riebeckite/plugin-l10n` is present, each page
+receives navigation for the current language only. The plugin always uses the
+resolved manifest permalink, so permalink, alias, rename, and l10n URL behavior
+remain owned by the content system.
+
+Only published entries are included. Draft, private, excluded, hidden, and
+outside-root content does not appear in the sidebar or previous/next sequence.
+
+## Exports
+
+- `docs(options)` / `docsPlugin(options)` — plugin factory
+- `buildDocsNavigation(entries, options)` — build the framework-independent model
+- `flattenDocsNavigation(items)` — derive the previous/next sequence
+- `renderDocsSidebar(...)` and `renderDocsPrevNext(...)` — server HTML renderers
+- `initDocsSidebar()` — browser init for the collapsible sidebar (also via
+  `@riebeckite/plugin-docs/client`)
+- Types: `DocsOptions`, `ResolvedDocsOptions`, `DocsNavigationItem`

package/README_ja.md

@@ -0,0 +1,88 @@
+# @riebeckite/plugin-docs
+
+<!-- Generated from docs/docs/plugins/docs.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
+Riebeckite の Markdown コンテンツから、Docs 用のサイドバーと前後ページリンクを
+ビルド時に生成するプラグインです。Docs 専用の router は追加せず、公開 URL も
+ファイルシステムのパスから再計算しません。
+
+[English](./README.md)
+
+## インストール
+
+```sh
+pnpm add @riebeckite/plugin-docs
+```
+
+## 基本設定
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { docs } from "@riebeckite/plugin-docs";
+
+export default defineConfig({
+  plugins: [
+    docs({
+      root: "docs",
+      sidebar: { auto: true },
+      prevNext: true,
+    }),
+  ],
+});
+```
+
+`root` は Docs として扱うコンテンツサブツリーです。`root: "docs"` の場合、
+`content/docs/` 配下だけが対象になり、`notes/` や `blog/` には Docs の UI を出しません。
+
+## Frontmatter
+
+```yaml
+---
+title: Installation
+sidebar:
+  label: Install
+  order: 2
+  hidden: false
+  collapsed: false
+---
+```
+
+対応するメタデータは次の通りです。
+
+- `label`: ナビゲーションに表示する名前。未指定なら `title`、さらに未指定ならファイル名。
+- `order`: 明示的な並び順。未指定の項目は明示された order のあとを title、path の順に並びます。
+- `hidden`: サイドバーと前後ページリンクから除外します。
+- `collapsed`: Theme やクライアント側の拡張のために `data-docs-collapsed` として出力します。
+
+これらのフィールドはすべて任意です。`sidebar` frontmatter のないページも
+ナビゲーションに表示されます。階層はフォルダ構造に従い、ラベルは `title`、
+並び順はタイトル順になります。`sidebar` は Riebeckite 独自の拡張であり、サイト
+設定ではなくコンテンツ側に置きます。上書きしたいフィールドだけを指定し、それ
+以外は Vault に手を入れないでください。
+
+## Theme との統合
+
+Plugin は React ライクな JSX コンポーネントをサイト統合に提供します。
+
+- `<DocsSidebar items={...} currentPermalink? label? />` は `nav.rr-docs-sidebar` を描画
+- `<DocsPrevNext previous? next? />` は `nav.rr-docs-prev-next` を描画
+
+クライアント `initDocsSidebar` はフッタリング可能なサイドバー動作のためにそのまま残ります。
+
+## l10n と公開の境界
+
+`@riebeckite/plugin-l10n` のメタデータがある場合、現在の言語に対応する項目だけで
+ナビゲーションを作ります。URL は manifest の解決済み permalink をそのまま使うため、
+permalink / alias / rename / l10n の責務を壊しません。
+
+公開対象の項目だけを含めます。draft、private、excluded、hidden、root 外のコンテンツは
+サイドバーと前後ページリンクに出ません。
+
+## エクスポート
+
+- `docs(options)` / `docsPlugin(options)`: プラグインファクトリ
+- `buildDocsNavigation(entries, options)`: フレームワークに依存しないナビゲーションモデル
+- `flattenDocsNavigation(items)`: 前後ページリンク用の並び
+- `renderDocsSidebar(...)` / `renderDocsPrevNext(...)`: サーバー側の HTML レンダラー
+- `initDocsSidebar()`: 畳めるサイドバーのブラウザ側初期化（`@riebeckite/plugin-docs/client` からも読み込める）
+- 型: `DocsOptions`、`ResolvedDocsOptions`、`DocsNavigationItem`

package/dist/client.d.ts

@@ -0,0 +1 @@
+export { initDocsSidebar } from "./src/docs-sidebar.client.js";

package/dist/client.js

@@ -0,0 +1,31 @@
+// src/docs-sidebar.client.ts
+var COLLAPSIBLE_PROPERTY = "--rb-docs-sidebar-collapsible";
+function initDocsSidebar() {
+  const details = Array.from(
+    document.querySelectorAll(
+      "[data-docs-sidebar-details]"
+    )
+  );
+  const first = details[0];
+  if (!first) return;
+  let collapsible = isCollapsible(first);
+  const apply = (value) => {
+    for (const element of details) {
+      element.open = !value;
+    }
+  };
+  apply(collapsible);
+  const sync = () => {
+    const next = isCollapsible(first);
+    if (next === collapsible) return;
+    collapsible = next;
+    apply(next);
+  };
+  window.addEventListener("resize", sync, { passive: true });
+}
+function isCollapsible(element) {
+  return getComputedStyle(element).getPropertyValue(COLLAPSIBLE_PROPERTY).trim() !== "0";
+}
+export {
+  initDocsSidebar
+};

package/dist/components/docs-prev-next.d.ts

@@ -0,0 +1,8 @@
+import type { DocsNavigationLink } from "../src/types.js";
+export type DocsPrevNextProps = {
+    readonly previous?: DocsNavigationLink;
+    readonly next?: DocsNavigationLink;
+    readonly language?: string;
+};
+declare const DocsPrevNext: ({ previous, next, language, }: Readonly<DocsPrevNextProps>) => import("hono/jsx/jsx-dev-runtime").JSX.Element;
+export default DocsPrevNext;

package/dist/components/docs-sidebar.d.ts

@@ -0,0 +1,8 @@
+import type { DocsNavigationItem } from "../src/types.js";
+export type DocsSidebarProps = {
+    readonly items: readonly DocsNavigationItem[];
+    readonly currentPermalink?: string;
+    readonly label?: string;
+};
+declare const DocsSidebar: ({ items, currentPermalink, label, }: Readonly<DocsSidebarProps>) => import("hono/jsx/jsx-dev-runtime").JSX.Element;
+export default DocsSidebar;

package/dist/components/docs-sidebar.js

@@ -0,0 +1,38 @@
+// components/docs-sidebar.tsx
+import { jsx, jsxs } from "hono/jsx/jsx-runtime";
+var DocsSidebar = (({
+  items,
+  currentPermalink,
+  label = "Docs navigation"
+}) => {
+  if (items.length === 0) return null;
+  return /* @__PURE__ */ jsx("nav", { class: "rr-docs-sidebar", "aria-label": label, children: /* @__PURE__ */ jsx("ol", { class: "rr-docs-sidebar__list", children: items.map((item) => /* @__PURE__ */ jsx(
+    DocsSidebarItem,
+    {
+      item,
+      currentPermalink
+    },
+    `${item.slug ?? item.title}`
+  )) }) });
+});
+function DocsSidebarItem({
+  item,
+  currentPermalink
+}) {
+  const current = item.href === currentPermalink;
+  return /* @__PURE__ */ jsxs("li", { class: "rr-docs-sidebar__item", children: [
+    item.href ? /* @__PURE__ */ jsx("a", { href: item.href, "aria-current": current ? "page" : void 0, children: item.title }) : /* @__PURE__ */ jsx("span", { children: item.title }),
+    item.children.length > 0 ? /* @__PURE__ */ jsx("ol", { class: "rr-docs-sidebar__list", children: item.children.map((child) => /* @__PURE__ */ jsx(
+      DocsSidebarItem,
+      {
+        item: child,
+        currentPermalink
+      },
+      `${child.slug ?? child.title}`
+    )) }) : null
+  ] });
+}
+var docs_sidebar_default = DocsSidebar;
+export {
+  docs_sidebar_default as default
+};

package/dist/index.d.ts

@@ -0,0 +1,25 @@
+import { type PluginDataHelper, type PublicContentView } from "@riebeckite/core";
+import type { DocsNavigationItem, DocsNavigationLink, DocsOptions } from "./src/types.js";
+export type { DocsPrevNextProps } from "./components/docs-prev-next.js";
+export { default as DocsPrevNext } from "./components/docs-prev-next.js";
+export type { DocsSidebarProps } from "./components/docs-sidebar.js";
+export { default as DocsSidebar } from "./components/docs-sidebar.js";
+export { initDocsSidebar } from "./src/docs-sidebar.client.js";
+export { buildDocsNavigation, flattenDocsNavigation, resolveDocsOptions, } from "./src/navigation.js";
+export { renderDocsPrevNext, renderDocsSidebar } from "./src/render.js";
+export type { DocsNavigationItem, DocsOptions, DocsSidebarFrontmatter, ResolvedDocsOptions, } from "./src/types.js";
+export declare const getDocsNavigation: PluginDataHelper<{
+    view: PublicContentView;
+    entrySlug: string;
+    options: DocsOptions;
+}, readonly DocsNavigationItem[]>;
+export declare const getDocsPrevNext: PluginDataHelper<{
+    items: readonly DocsNavigationItem[];
+    slug: string;
+}, {
+    readonly previous?: DocsNavigationLink;
+    readonly next?: DocsNavigationLink;
+}>;
+export declare const DOCS_PLUGIN_NAME = "docs";
+export declare function docs(options: DocsOptions): import("@riebeckite/core").RiebeckitePlugin<DocsOptions>;
+export declare const docsPlugin: typeof docs;

package/dist/index.js

@@ -0,0 +1,415 @@
+// index.ts
+import {
+  createClientEntry,
+  createStyleAsset,
+  definePlugin
+} from "@riebeckite/core";
+
+// src/navigation.ts
+var ROOT_SEGMENT = "";
+function resolveDocsOptions(options) {
+  return {
+    root: normalizeRoot(options.root),
+    sidebar: {
+      auto: options.sidebar?.auto ?? true,
+      label: options.sidebar?.label ?? "Docs navigation"
+    },
+    prevNext: options.prevNext ?? true
+  };
+}
+function buildDocsNavigation(entries, options) {
+  if (!options.sidebar.auto) return [];
+  const docsEntries = entries.map((entry) => toNavigationEntry(entry, options.root)).filter((entry) => Boolean(entry)).filter((entry) => !entry.hidden);
+  const root = createTreeNode(ROOT_SEGMENT);
+  for (const entry of docsEntries) addEntry(root, entry);
+  const rootIndex = root.index;
+  const items = buildItems(root, []);
+  if (!rootIndex) return items;
+  return [toItem(rootIndex, []), ...items];
+}
+function flattenDocsNavigation(items) {
+  return items.flatMap((item) => {
+    const current = item.href && item.slug ? [{ title: item.title, href: item.href, slug: item.slug }] : [];
+    return [...current, ...flattenDocsNavigation(item.children)];
+  });
+}
+function normalizeRoot(root) {
+  return root.replace(/\\/g, "/").replace(/^\/+|\/+$/g, "");
+}
+function toNavigationEntry(entry, root) {
+  const relativePath = resolveRelativeDocsPath(entry, root);
+  if (!relativePath) return null;
+  const segments = relativePath.split("/").filter(Boolean);
+  const isIndex = ["index", "README"].includes(segments.at(-1) ?? "");
+  const sidebar = readSidebarFrontmatter(
+    "frontmatter" in entry ? entry.frontmatter.sidebar : void 0
+  );
+  return {
+    entry,
+    relativePath,
+    segments,
+    isIndex,
+    title: resolveTitle(entry, sidebar),
+    order: sidebar.order,
+    hidden: sidebar.hidden ?? false,
+    collapsed: sidebar.collapsed
+  };
+}
+function resolveRelativeDocsPath(entry, root) {
+  if (entry.slug === root) return "index";
+  if (!entry.slug.startsWith(`${root}/`)) return null;
+  return stripFilenameLanguage(
+    entry.slug.slice(root.length + 1),
+    entry.publicLocation.language
+  );
+}
+function stripFilenameLanguage(path, language) {
+  if (!language) return path;
+  const segments = path.split("/");
+  const last = segments.at(-1);
+  if (last === void 0) return path;
+  segments[segments.length - 1] = last.replace(
+    new RegExp(`[._-]${escapeRegExp(language)}$`, "i"),
+    ""
+  );
+  return segments.join("/");
+}
+function escapeRegExp(value) {
+  return value.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+function readSidebarFrontmatter(value) {
+  if (!value || typeof value !== "object" || Array.isArray(value)) return {};
+  const record = value;
+  return {
+    ...typeof record.label === "string" && record.label.trim() ? { label: record.label.trim() } : {},
+    ...typeof record.order === "number" && Number.isFinite(record.order) ? { order: record.order } : {},
+    ...typeof record.hidden === "boolean" ? { hidden: record.hidden } : {},
+    ...typeof record.collapsed === "boolean" ? { collapsed: record.collapsed } : {}
+  };
+}
+function resolveTitle(entry, sidebar) {
+  if (sidebar.label) return sidebar.label;
+  if (entry.title.trim()) return entry.title.trim();
+  return titleFromSegment(entry.slug.split("/").at(-1) ?? entry.slug);
+}
+function addEntry(root, entry) {
+  const path = entry.isIndex ? entry.segments.slice(0, -1) : entry.segments;
+  let node = root;
+  for (const segment of path) {
+    const child = node.children.get(segment) ?? createTreeNode(segment);
+    node.children.set(segment, child);
+    node = child;
+  }
+  if (entry.isIndex) node.index = entry;
+  else node.page = entry;
+}
+function buildItems(node, path) {
+  return [...node.children.values()].toSorted(compareNodes).map((child) => nodeToItem(child, [...path, child.segment]));
+}
+function nodeToItem(node, path) {
+  const primary = node.index ?? node.page;
+  const children = [
+    ...node.index && node.page ? [toItem(node.page, [])] : [],
+    ...buildItems(node, path)
+  ];
+  if (primary) return toItem(primary, children);
+  return {
+    title: titleFromSegment(node.segment),
+    children
+  };
+}
+function toItem(entry, children) {
+  return {
+    title: entry.title,
+    href: entry.entry.permalink,
+    slug: entry.entry.slug,
+    ...entry.order === void 0 ? {} : { order: entry.order },
+    ...entry.collapsed === void 0 ? {} : { collapsed: entry.collapsed },
+    children
+  };
+}
+function compareNodes(a, b) {
+  const left = a.index ?? a.page;
+  const right = b.index ?? b.page;
+  return compareNavigationKeys(
+    left?.order,
+    left?.title ?? titleFromSegment(a.segment),
+    a.segment,
+    right?.order,
+    right?.title ?? titleFromSegment(b.segment),
+    b.segment
+  );
+}
+function compareNavigationKeys(leftOrder, leftTitle, leftPath, rightOrder, rightTitle, rightPath) {
+  if (leftOrder !== void 0 || rightOrder !== void 0) {
+    if (leftOrder === void 0) return 1;
+    if (rightOrder === void 0) return -1;
+    const order = leftOrder - rightOrder;
+    if (order !== 0) return order;
+  }
+  const title = leftTitle.localeCompare(rightTitle, "en", {
+    sensitivity: "base"
+  });
+  if (title !== 0) return title;
+  return leftPath.localeCompare(rightPath, "en", { sensitivity: "base" });
+}
+function createTreeNode(segment) {
+  return { segment, children: /* @__PURE__ */ new Map() };
+}
+function titleFromSegment(segment) {
+  return segment.replace(/[-_]+/g, " ").replace(/\b\p{L}/gu, (letter) => letter.toLocaleUpperCase("en"));
+}
+
+// components/docs-prev-next.tsx
+import { jsx, jsxs } from "hono/jsx/jsx-runtime";
+var DocsPrevNext = (({
+  previous,
+  next,
+  language
+}) => {
+  if (!previous && !next) return null;
+  const labels = language === "ja" ? { nav: "前後のドキュメント", previous: "前へ", next: "次へ" } : {
+    nav: "Previous and next docs pages",
+    previous: "Previous",
+    next: "Next"
+  };
+  return /* @__PURE__ */ jsxs("nav", { class: "rb-docs-prev-next", "aria-label": labels.nav, "data-docs-prev-next": true, children: [
+    previous ? /* @__PURE__ */ jsxs(
+      "a",
+      {
+        class: "rb-docs-prev-next__link rb-docs-prev-next__link--previous",
+        rel: "prev",
+        href: previous.href,
+        "data-docs-previous": true,
+        children: [
+          /* @__PURE__ */ jsx("span", { class: "rb-docs-prev-next__label", children: labels.previous }),
+          /* @__PURE__ */ jsxs("span", { class: "rb-docs-prev-next__title", children: [
+            "← ",
+            previous.title
+          ] })
+        ]
+      }
+    ) : /* @__PURE__ */ jsx("span", { class: "rb-docs-prev-next__spacer", "aria-hidden": "true" }),
+    next ? /* @__PURE__ */ jsxs(
+      "a",
+      {
+        class: "rb-docs-prev-next__link rb-docs-prev-next__link--next",
+        rel: "next",
+        href: next.href,
+        "data-docs-next": true,
+        children: [
+          /* @__PURE__ */ jsx("span", { class: "rb-docs-prev-next__label", children: labels.next }),
+          /* @__PURE__ */ jsxs("span", { class: "rb-docs-prev-next__title", children: [
+            next.title,
+            " →"
+          ] })
+        ]
+      }
+    ) : null
+  ] });
+});
+var docs_prev_next_default = DocsPrevNext;
+
+// components/docs-sidebar.tsx
+import { jsx as jsx2, jsxs as jsxs2 } from "hono/jsx/jsx-runtime";
+var DocsSidebar = (({
+  items,
+  currentPermalink,
+  label = "Docs navigation"
+}) => {
+  if (items.length === 0) return null;
+  return /* @__PURE__ */ jsx2("nav", { class: "rr-docs-sidebar", "aria-label": label, children: /* @__PURE__ */ jsx2("ol", { class: "rr-docs-sidebar__list", children: items.map((item) => /* @__PURE__ */ jsx2(
+    DocsSidebarItem,
+    {
+      item,
+      currentPermalink
+    },
+    `${item.slug ?? item.title}`
+  )) }) });
+});
+function DocsSidebarItem({
+  item,
+  currentPermalink
+}) {
+  const current = item.href === currentPermalink;
+  return /* @__PURE__ */ jsxs2("li", { class: "rr-docs-sidebar__item", children: [
+    item.href ? /* @__PURE__ */ jsx2("a", { href: item.href, "aria-current": current ? "page" : void 0, children: item.title }) : /* @__PURE__ */ jsx2("span", { children: item.title }),
+    item.children.length > 0 ? /* @__PURE__ */ jsx2("ol", { class: "rr-docs-sidebar__list", children: item.children.map((child) => /* @__PURE__ */ jsx2(
+      DocsSidebarItem,
+      {
+        item: child,
+        currentPermalink
+      },
+      `${child.slug ?? child.title}`
+    )) }) : null
+  ] });
+}
+var docs_sidebar_default = DocsSidebar;
+
+// src/docs-sidebar.client.ts
+var COLLAPSIBLE_PROPERTY = "--rb-docs-sidebar-collapsible";
+function initDocsSidebar() {
+  const details = Array.from(
+    document.querySelectorAll(
+      "[data-docs-sidebar-details]"
+    )
+  );
+  const first = details[0];
+  if (!first) return;
+  let collapsible = isCollapsible(first);
+  const apply = (value) => {
+    for (const element of details) {
+      element.open = !value;
+    }
+  };
+  apply(collapsible);
+  const sync = () => {
+    const next = isCollapsible(first);
+    if (next === collapsible) return;
+    collapsible = next;
+    apply(next);
+  };
+  window.addEventListener("resize", sync, { passive: true });
+}
+function isCollapsible(element) {
+  return getComputedStyle(element).getPropertyValue(COLLAPSIBLE_PROPERTY).trim() !== "0";
+}
+
+// src/render.ts
+function renderDocsSidebar(context) {
+  if (context.items.length === 0) return "";
+  const label = escapeAttribute(context.label);
+  return `<details class="rb-docs-sidebar-details" data-docs-sidebar-details open><summary class="rb-docs-sidebar-summary">${label}</summary><nav class="rb-docs-sidebar" aria-label="${label}" data-docs-sidebar>${renderItems(context.items, context.currentPermalink, 1)}</nav></details>`;
+}
+function renderDocsPrevNext(sequence, currentPermalink, language) {
+  const index = sequence.findIndex((item) => item.href === currentPermalink);
+  if (index < 0) return "";
+  const previous = sequence[index - 1];
+  const next = sequence[index + 1];
+  if (!previous && !next) return "";
+  const labels = prevNextLabels(language);
+  return `<nav class="rb-docs-prev-next" aria-label="${escapeAttribute(labels.nav)}" data-docs-prev-next>${renderPrevNextLink(previous, "previous", labels)} ${renderPrevNextLink(next, "next", labels)}</nav>`;
+}
+function renderItems(items, currentPermalink, level) {
+  return `<ul class="rb-docs-sidebar__list rb-docs-sidebar__list--level-${level}" data-docs-level="${level}">${items.map((item) => renderItem(item, currentPermalink, level)).join("")}</ul>`;
+}
+function renderItem(item, currentPermalink, level) {
+  const isCurrent = item.href === currentPermalink;
+  const isCurrentBranch = item.children.some(
+    (child) => containsPermalink(child, currentPermalink)
+  );
+  const children = item.children.length > 0 ? renderItems(item.children, currentPermalink, level + 1) : "";
+  const collapsed = item.collapsed === true && !isCurrent && !isCurrentBranch;
+  const state = item.children.length > 0 ? ` data-docs-collapsed="${collapsed ? "true" : "false"}"` : "";
+  return `<li class="rb-docs-sidebar__item rb-docs-sidebar__item--level-${level}" data-docs-level="${level}"${state}>${renderItemLabel(item, isCurrent)}${children}</li>`;
+}
+function containsPermalink(item, currentPermalink) {
+  return item.href === currentPermalink || item.children.some((child) => containsPermalink(child, currentPermalink));
+}
+function renderItemLabel(item, isCurrent) {
+  const current = isCurrent ? ' aria-current="page"' : "";
+  if (!item.href)
+    return `<span class="rb-docs-sidebar__section" data-docs-section>${escapeHtml(item.title)}</span>`;
+  return `<a class="rb-docs-sidebar__link" href="${escapeAttribute(item.href)}" data-docs-link${current}>${escapeHtml(item.title)}</a>`;
+}
+function renderPrevNextLink(item, rel, labels) {
+  if (!item)
+    return `<span class="rb-docs-prev-next__spacer" aria-hidden="true"></span>`;
+  const label = rel === "previous" ? labels.previous : labels.next;
+  const arrow = rel === "previous" ? "←" : "→";
+  return `<a class="rb-docs-prev-next__link rb-docs-prev-next__link--${rel}" href="${escapeAttribute(item.href)}" data-docs-${rel}><span class="rb-docs-prev-next__label">${label}</span><span class="rb-docs-prev-next__title">${rel === "previous" ? `${arrow} ` : ""}${escapeHtml(item.title)}${rel === "next" ? ` ${arrow}` : ""}</span></a>`;
+}
+var PREV_NEXT_LABELS = {
+  en: {
+    nav: "Previous and next docs pages",
+    previous: "Previous",
+    next: "Next"
+  },
+  ja: {
+    nav: "前後のドキュメント",
+    previous: "前へ",
+    next: "次へ"
+  }
+};
+function prevNextLabels(language) {
+  if (language === "ja") return PREV_NEXT_LABELS.ja;
+  return PREV_NEXT_LABELS.en;
+}
+function escapeHtml(value) {
+  return value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
+}
+function escapeAttribute(value) {
+  return escapeHtml(value);
+}
+
+// index.ts
+var getDocsNavigation = ({ view, entrySlug, options }) => {
+  const entry = view.findRoutableBySlug(entrySlug);
+  if (!entry) return [];
+  const localized = view.discoverableEntries.filter(
+    (candidate) => candidate.publicLocation.language === entry.publicLocation.language
+  );
+  return buildDocsNavigation(localized, resolveDocsOptions(options));
+};
+var getDocsPrevNext = ({ items, slug }) => {
+  const sequence = flattenDocsNavigation(items);
+  const index = sequence.findIndex((item) => item.slug === slug);
+  if (index < 0) return {};
+  return {
+    ...sequence[index - 1] ? { previous: sequence[index - 1] } : {},
+    ...sequence[index + 1] ? { next: sequence[index + 1] } : {}
+  };
+};
+var DOCS_PLUGIN_NAME = "docs";
+function docs(options) {
+  const resolved = resolveDocsOptions(options);
+  return definePlugin({
+    name: `${DOCS_PLUGIN_NAME}:${resolved.root}`,
+    order: 300,
+    contentOutputDependencies: [{ type: "global" }],
+    options,
+    validateOptions: validateDocsOptions,
+    assets: [
+      createStyleAsset(DOCS_PLUGIN_NAME, "@riebeckite/plugin-docs/style.css")
+    ],
+    clientEntries: [
+      createClientEntry(
+        DOCS_PLUGIN_NAME,
+        "@riebeckite/plugin-docs/client",
+        "initDocsSidebar"
+      )
+    ]
+  });
+}
+var docsPlugin = docs;
+function validateDocsOptions(options) {
+  const issues = [];
+  if (!options || typeof options !== "object") {
+    return [{ path: "docs", message: "Expected docs options." }];
+  }
+  if (typeof options.root !== "string" || options.root.trim() === "") {
+    issues.push({ path: "root", message: "Expected a non-empty string." });
+  }
+  if (options.sidebar !== void 0 && typeof options.sidebar !== "object") {
+    issues.push({ path: "sidebar", message: "Expected an object." });
+  }
+  if (options.prevNext !== void 0 && typeof options.prevNext !== "boolean") {
+    issues.push({ path: "prevNext", message: "Expected a boolean." });
+  }
+  return issues;
+}
+export {
+  DOCS_PLUGIN_NAME,
+  docs_prev_next_default as DocsPrevNext,
+  docs_sidebar_default as DocsSidebar,
+  buildDocsNavigation,
+  docs,
+  docsPlugin,
+  flattenDocsNavigation,
+  getDocsNavigation,
+  getDocsPrevNext,
+  initDocsSidebar,
+  renderDocsPrevNext,
+  renderDocsSidebar,
+  resolveDocsOptions
+};

package/dist/src/docs-sidebar.client.d.ts

@@ -0,0 +1 @@
+export declare function initDocsSidebar(): void;

package/dist/src/navigation.d.ts

@@ -0,0 +1,4 @@
+import type { DocsContentEntry, DocsNavigationItem, DocsNavigationLink, DocsOptions, ResolvedDocsOptions } from "./types.js";
+export declare function resolveDocsOptions(options: DocsOptions): ResolvedDocsOptions;
+export declare function buildDocsNavigation(entries: readonly DocsContentEntry[], options: ResolvedDocsOptions): readonly DocsNavigationItem[];
+export declare function flattenDocsNavigation(items: readonly DocsNavigationItem[]): readonly DocsNavigationLink[];

package/dist/src/render.d.ts

@@ -0,0 +1,7 @@
+import type { DocsNavigationItem, DocsNavigationLink } from "./types.js";
+export declare function renderDocsSidebar(context: {
+    readonly items: readonly DocsNavigationItem[];
+    readonly currentPermalink: string;
+    readonly label: string;
+}): string;
+export declare function renderDocsPrevNext(sequence: readonly DocsNavigationLink[], currentPermalink: string, language?: string): string;

package/dist/src/types.d.ts

@@ -0,0 +1,47 @@
+import type { ContentManifestEntry, PublicContentEntry } from "@riebeckite/core";
+export type DocsContentEntry = ContentManifestEntry | PublicContentEntry;
+export type DocsOptions = {
+    readonly root: string;
+    readonly sidebar?: {
+        readonly auto?: boolean;
+        readonly label?: string;
+    };
+    readonly prevNext?: boolean;
+};
+export type ResolvedDocsOptions = {
+    readonly root: string;
+    readonly sidebar: {
+        readonly auto: boolean;
+        readonly label: string;
+    };
+    readonly prevNext: boolean;
+};
+export type DocsSidebarFrontmatter = {
+    readonly label?: string;
+    readonly order?: number;
+    readonly hidden?: boolean;
+    readonly collapsed?: boolean;
+};
+export type DocsNavigationItem = {
+    readonly title: string;
+    readonly href?: string;
+    readonly slug?: string;
+    readonly order?: number;
+    readonly collapsed?: boolean;
+    readonly children: readonly DocsNavigationItem[];
+};
+export type DocsNavigationEntry = {
+    readonly entry: DocsContentEntry;
+    readonly relativePath: string;
+    readonly segments: readonly string[];
+    readonly isIndex: boolean;
+    readonly title: string;
+    readonly order: number | undefined;
+    readonly hidden: boolean;
+    readonly collapsed: boolean | undefined;
+};
+export type DocsNavigationLink = {
+    readonly title: string;
+    readonly href: string;
+    readonly slug: string;
+};

package/package.json

@@ -1,6 +1,73 @@
 {
   "name": "@riebeckite/plugin-docs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.23",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "source": "./index.ts",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client.d.ts",
+      "import": "./dist/client.js",
+      "source": "./client.ts",
+      "default": "./dist/client.js"
+    },
+    "./components": {
+      "types": "./dist/components/docs-sidebar.d.ts",
+      "import": "./dist/components/docs-sidebar.js",
+      "source": "./components/docs-sidebar.tsx",
+      "default": "./dist/components/docs-sidebar.js"
+    },
+    "./style.css": "./style.css"
+  },
+  "dependencies": {
+    "hono": "^4.12.25",
+    "@riebeckite/core": "0.0.23"
+  },
+  "devDependencies": {
+    "tsx": "^4.22.4",
+    "@riebeckite/test": "0.0.23"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist",
+    "style.css"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/plugins/docs"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Build-time docs sidebar and previous/next navigation for Riebeckite.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "docs",
+    "navigation"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": [
+    "./style.css"
+  ],
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs",
+    "test": "node --import tsx --test \"test/*.test.ts\""
+  }
 }

package/style.css

@@ -0,0 +1,85 @@
+.rb-docs-sidebar-details {
+  --rb-docs-sidebar-collapsible: 1;
+}
+
+.rb-docs-sidebar-details > .rb-docs-sidebar-summary {
+  cursor: pointer;
+  font-size: 0.95rem;
+}
+
+@media (min-width: 88rem) {
+  .rb-docs-sidebar-details {
+    --rb-docs-sidebar-collapsible: 0;
+  }
+
+  .rb-docs-sidebar-details > .rb-docs-sidebar-summary {
+    display: none;
+  }
+}
+
+.rb-docs-sidebar {
+  font-size: 0.95rem;
+}
+
+.rb-docs-sidebar__list {
+  list-style: none;
+  margin: 0;
+  padding: 0;
+}
+
+.rb-docs-sidebar__list--level-2,
+.rb-docs-sidebar__list--level-3,
+.rb-docs-sidebar__list--level-4 {
+  margin-block-start: 0.25rem;
+  padding-inline-start: 1rem;
+}
+
+.rb-docs-sidebar__item + .rb-docs-sidebar__item {
+  margin-block-start: 0.25rem;
+}
+
+.rb-docs-sidebar__item[data-docs-collapsed="true"] > .rb-docs-sidebar__list {
+  display: none;
+}
+
+.rb-docs-sidebar__link,
+.rb-docs-sidebar__section {
+  display: block;
+  color: inherit;
+  text-decoration: none;
+}
+
+.rb-docs-sidebar__link[aria-current="page"] {
+  font-weight: 700;
+}
+
+.rb-docs-prev-next {
+  display: flex;
+  flex-wrap: wrap;
+  justify-content: space-between;
+  gap: 1rem;
+  margin-block-start: var(--rb-space-6, 3rem);
+}
+
+.rb-docs-prev-next__link {
+  flex: 1 1 14rem;
+  min-width: 0;
+  color: inherit;
+  overflow-wrap: anywhere;
+  text-decoration: none;
+}
+
+.rb-docs-prev-next__link--next {
+  margin-inline-start: auto;
+  text-align: end;
+}
+
+.rb-docs-prev-next__label {
+  display: block;
+  font-size: 0.75em;
+  opacity: 0.72;
+}
+
+.rb-docs-prev-next__spacer {
+  flex: 1 1 14rem;
+}