https://riebeckite.dev/An open-source framework for building extensible websites from Markdown and Obsidian notes.jahttps://riebeckite.dev/en/https://riebeckite.dev/en/Riebeckite is an open-source framework for publishing Markdown and Obsidian notes as a website.https://riebeckite.dev/READMEhttps://riebeckite.dev/READMERiebeckite ドキュメント Riebeckite は、 Markdown や Obsidian のノートから公開サイトを作るためのフレームワーク です。 Markdown を content/ に置くだけのシンプルなサイトから、プラグイン、テーマ、多言語化、外部の Obsidian Vault を使うサイトまでhttps://riebeckite.dev/assets/HWhttps://riebeckite.dev/assets/HW⚠ Switch to EXCALIDRAW VIEW in the MORE OPTIONS menu of this document. ⚠ You can decompress Drawing data with the command palette: 'Decompress current Excalidrahttps://riebeckite.dev/en/docs/https://riebeckite.dev/en/docs/Documentation Start with Getting Started to create and publish a Riebeckite site. Use the sections below to explore the framework, extend it with plugins, and chttps://riebeckite.dev/docs/https://riebeckite.dev/docs/ドキュメント Riebeckite でサイトを作成して公開するまでの流れは、 Getting Started から確認できます。フレームワークの仕組み、Plugin による拡張、見た目の調整は、以下の各章を参照してください。 Getting Started ガイド フレームワーク Plugin Theme リファレンスhttps://riebeckite.dev/en/docs/accessibilityhttps://riebeckite.dev/en/docs/accessibilityAccessibility Riebeckite aims to follow WCAG 2.2 AA guidance, but it does not make a blanket compliance claim. The accessibility of a published site depends on https://riebeckite.dev/docs/accessibilityhttps://riebeckite.dev/docs/accessibilityアクセシビリティ Riebeckiteでは、キーボード操作やスクリーンリーダー、文字の見やすさなど、さまざまな環境でサイトを利用できることを大切にしています。 WCAG 2.2 AAを参考にしていますが、最終的なサイトのアクセシビリティは、使用するThemeやPlugin、記事の内容、独自に追加したコードによっても変わhttps://riebeckite.dev/en/docs/framework/https://riebeckite.dev/en/docs/framework/Framework Framework documentation is for people who want to understand or develop Riebeckite itself. If you only want to build a site, start with Getting Startehttps://riebeckite.dev/docs/framework/https://riebeckite.dev/docs/framework/Framework この章では、 Riebeckite 自体がどのように動いているか を説明します。 対象となるのは、 Riebeckite の内部構造を理解したい人 Plugin や Theme の仕組みを詳しく知りたい人 Riebeckite 本体を開発・変更したい人 です。 Riebeckite を使って自分のサhttps://riebeckite.dev/en/docs/framework/architecturehttps://riebeckite.dev/en/docs/framework/architectureArchitecture Package ownership Riebeckite is a pnpm workspace with intentionally one-way dependencies. Area Owns Must not own packages/core portable contracts, https://riebeckite.dev/docs/framework/architecturehttps://riebeckite.dev/docs/framework/architectureArchitecture Riebeckite は、Core を中心に Plugin、Integration、Theme、Application を分離した pnpm workspace です。 重要な原則は、 内側の package が外側の実装を知らないこと です。 たとえば Core はコンテンツ処理の仕組みを提https://riebeckite.dev/en/docs/framework/build-dependencyhttps://riebeckite.dev/en/docs/framework/build-dependencyBuild Dependency Contract Core owns incremental invalidation. A plugin does not compute which content is affected, and it does not keep its own dependency statehttps://riebeckite.dev/docs/framework/build-dependencyhttps://riebeckite.dev/docs/framework/build-dependencyBuild Dependency Contract Incremental Buildの無効化はCoreの責務です。PluginはどのContentが影響を受けるかを計算せず、依存stateも自分では持ちません。契約を宣言すると、何を再利用するかはCoreが決めます。 Pluginが関わる契約は、Content Dephttps://riebeckite.dev/en/docs/framework/build-systemhttps://riebeckite.dev/en/docs/framework/build-systemBuild System What a build owns An explicit build resolves configuration and plugins, reads content, runs content and plugin pipelines, creates the manifest and https://riebeckite.dev/docs/framework/build-systemhttps://riebeckite.dev/docs/framework/build-systemBuild System Riebeckite の Build System は、Markdown などのコンテンツと設定を読み込み、最終的な Web サイトを生成する仕組みです。 通常の build では、大きく次の処理を行います。 設定とプラグインを読み込む Markdown などのコンテンツを読み込む プラグインhttps://riebeckite.dev/en/docs/framework/content-systemhttps://riebeckite.dev/en/docs/framework/content-systemContent System Two explicit responsibilities ContentSource is the boundary for finding and reading source data. It owns scanning, reading, identity, and source https://riebeckite.dev/docs/framework/content-systemhttps://riebeckite.dev/docs/framework/content-systemContent System Content System は、Markdown や画像などのファイルを、Riebeckite がサイトとして扱えるコンテンツへ変換する仕組みです。 単に Markdown を HTML に変換するだけではありません。 Riebeckite が、 このファイルは何の記事なのか 公開してよhttps://riebeckite.dev/en/docs/framework/developmenthttps://riebeckite.dev/en/docs/framework/developmentFramework Development This page is for people developing Riebeckite itself: core, CLI, HonoX integration, official plugins, official themes, templates, or the rhttps://riebeckite.dev/docs/framework/developmenthttps://riebeckite.dev/docs/framework/developmentFramework Development このページは、 Riebeckite 本体を開発する人向け のガイドです。 次のような変更を行う場合に、この monorepo を使用します。 Core の機能を追加・変更する CLI を変更する HonoX Integration を変更する 公式 Plugin / Thehttps://riebeckite.dev/en/docs/framework/diagnosticshttps://riebeckite.dev/en/docs/framework/diagnosticsDiagnostics Diagnostics are structured findings emitted by Core, plugins, and tooling. They make invalid configuration, content issues, capability problems, andhttps://riebeckite.dev/docs/framework/diagnosticshttps://riebeckite.dev/docs/framework/diagnosticsDiagnostics Diagnostics は、Riebeckite の設定やコンテンツ、プラグイン、実行環境に問題がないかを検査し、開発者に報告するための仕組みです。 単にエラーメッセージを console.log へ出すのではなく、 何が問題なのか どこで問題が起きているのか どの程度重要なのか どう直せばよいhttps://riebeckite.dev/en/docs/framework/honox-integrationhttps://riebeckite.dev/en/docs/framework/honox-integrationHonoX Integration @riebeckite/honox connects portable Core behavior to HonoX and Vite. It owns application-root/config resolution, Vite development and build inhttps://riebeckite.dev/docs/framework/honox-integrationhttps://riebeckite.dev/docs/framework/honox-integrationHonoX Integration @riebeckite/honox は、Riebeckite Core と HonoX / Vite を接続する integration です。 Core はコンテンツやプラグインの処理を担当しますが、HonoX の route や Vite の build 方法については知りませんhttps://riebeckite.dev/en/docs/framework/inspectorhttps://riebeckite.dev/en/docs/framework/inspectorInspector Inspector answers questions about already-resolved state. Use it through the CLI: sh Wrap Copy riebeckite inspect config riebeckite inspect plugins rihttps://riebeckite.dev/docs/framework/inspectorhttps://riebeckite.dev/docs/framework/inspectorInspector Inspector は、Riebeckite がすでに解決した設定やコンテンツ、Plugin、Build State を確認するための機能です。 簡単に言えば、 「Riebeckite から今どう見えているか」を調べるための読み取り専用ツール です。 たとえば、 実際にどの設定が使われているか どのhttps://riebeckite.dev/en/docs/framework/observabilityhttps://riebeckite.dev/en/docs/framework/observabilityObservability Riebeckite separates logs, traces, and profiling so each answers a different question. Signal Answers Contract Logger What happened or failed? strhttps://riebeckite.dev/docs/framework/observabilityhttps://riebeckite.dev/docs/framework/observabilityObservability Observability は、Riebeckite の実行中に 何が起きたのか、どこに時間がかかったのか を調べるための仕組みです。 Riebeckite では目的の異なる3つの仕組みを分けています。 Logger — 何が起きたかを知る Tracer — どの処理にどれだけ時間がかかったhttps://riebeckite.dev/en/docs/framework/page-systemhttps://riebeckite.dev/en/docs/framework/page-systemPage System The Page System lets a plugin provide a standalone page without taking over an application route. It is a capability on the normal RiebeckitePlugin https://riebeckite.dev/docs/framework/page-systemhttps://riebeckite.dev/docs/framework/page-systemPage System Page System は、Plugin が Site の route を直接追加せずに独立したページを提供する ための仕組みです。 たとえば Plugin が、 text Wrap Copy /explore /report /tags/example のような独自ページを提供したい場合に使用https://riebeckite.dev/en/docs/framework/plugin-systemhttps://riebeckite.dev/en/docs/framework/plugin-systemPlugins in Depth Your First Plugin is a short walkthrough that gets a plugin running. This page is its "in depth" companion: it collects everything you refer to