付録

共通の型定義

このドキュメントでは、JSONやYAMLの構造をTypeScriptの型で擬似的に表現しています。以下はドキュメント全体で共通して使用される型です。

// MongoDB の ObjectId と同じフォーマットの文字列
// RegExp: /^[0-9a-fA-F]{24}$/
// 例: "69def372425493d783e66620"
type ObjectId = string;

// UUID フォーマットの文字列
// RegExp: /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
// 例: "63deca97-aac2-485b-a0a3-52ec4f094e19"
type Uuid = string;

用語集

用語	説明
Codatum	本CLI及びドキュメントを開発している会社・プロダクトの名称。本機能は Codatum のサービスの一部です
ノートブックファイル	拡張子(`.cnb.md`)を持つマークダウンファイル。本ドキュメントで説明する、マークダウン版のノートブックのファイルです
マークダウン版ノートブック	本ドキュメントで説明するマークダウン形式のノートブックのこと
Web版ノートブック	CodatumのWebサービスにログインしてブラウザで作成・管理するノートブックのこと。本ドキュメントで説明しているマークダウン形式のノートブックの上位互換で、Web版でしか利用できない機能があります
ページ属性	各ページの `h1` 直後の `yaml {.page}` のコードブロックで指定された属性
SQLブロック	ドキュメントページ内で `:::sql-block` コンテナディレクティブにより定義されたブロック。詳細は SQLブロックを参照

付録 ​

共通の型定義 ​

用語集 ​

付録

共通の型定義

用語集