Core API

@riebeckite/core が公開するもの

@riebeckite/core は、Riebeckite のフレームワークに依存しない公開 API を提供します。

主なエクスポート

• 設定: defineConfig、resolveConfig、resolveConfigModule、isPublished、isExcluded
• API ライフサイクル: defineApiLifecycle、createApiLifecycleRegistry、resolveApiLifecycle
• コンテンツ: ContentManager、ContentCollection、ContentGraph、queryContentEntries、buildContentCollections、selectLocalizedEntries、resolvePageLocale、localizedPagePaths、fingerprintContentEntries、resolveDefaultContentLocation
• プラグイン: definePlugin、resolvePlugins、defineEndpoint、createStyleAsset、createClientEntry、createPluginMemo、stableStringify
• テーマ: defineTheme、defineThemeSettings、ThemeDefinition、ThemeOptions、ThemeColorMode
• パイプライン: Pipeline、MarkdownPipeline、HtmlPipeline
• ユーティリティ: escapeHtml、escapeHtmlAttribute、normalizeTag、calculateReadingTime、stripHtml
• 可観測性: Logger、Tracer、TraceSpan、TraceSink

設定

defineConfig
resolveConfig
resolveConfigModule
isPublished
isExcluded

設定の宣言と解決、公開ポリシーに使用します。詳しくは 設定 を参照してください。

API ライフサイクル

defineApiLifecycle
validateApiLifecycleDefinition
createApiLifecycleRegistry
collectApiLifecycleDefinitions
resolveApiLifecycle
API_LIFECYCLE_DIAGNOSTIC_CODE
API_LIFECYCLE_METADATA_DIAGNOSTIC_CODE

非推奨 API の記録とメタデータの検証に使用します。詳しくは API ライフサイクル を参照してください。

コンテンツ

ContentManager
ContentCollection
ContentGraph
ContentQuerySpec
buildContentCollections
fingerprintContentEntries
resolveDefaultContentLocation

コンテンツの読み込みと解決、コレクション、コンテンツグラフ、クエリ、公開ロケーションに使用します。仕組みについては Content System を参照してください。

プラグイン

definePlugin
resolvePlugins
defineEndpoint
createStyleAsset
createClientEntry
createPluginMemo
stableStringify

プラグインの定義と解決、エンドポイントなどに使用します。プラグインを作成する場合は Plugin API と プラグイン作成の詳細 を参照してください。

テーマ

defineTheme
defineThemeSettings
ThemeDefinition
ThemeOptions
ThemeColorMode

テーマの定義とプレゼンテーションの取り決めに使用します。テーマを作成する場合は Theme API と テーマ作成の詳細 を参照してください。

パイプライン

Pipeline
MarkdownPipeline
HtmlPipeline

Markdown / HTML の処理パイプラインを拡張するときに使用します。通常のサイト利用で直接扱う必要はありません。

ユーティリティ

escapeHtml
escapeHtmlAttribute
normalizeTag
calculateReadingTime
stripHtml

プラグインやインテグレーションから利用できる共通のユーティリティです。

可観測性

Logger
Tracer
TraceSpan
TraceSink

ログやトレースをフレームワークと統合するための型です。詳しくは Observability を参照してください。