Markdown

概要

NocoBase では、Markdown（Markdown） を使用して Markdown 形式の内容を保存できます。

Markdown フィールドは、説明ドキュメント、対応方案、ナレッジベース本文、変更履歴などに適しています。保存されるのはテキストで、ページ上では Markdown としてレンダリングされます。

WYSIWYG 編集体験が必要な場合は、リッチテキストまたは Markdown Vditorを選択できます。

適用シーン

Markdown は、次のような業務シーンに適しています。

ナレッジベース本文、説明ドキュメント
対応方案、トラブルシューティング記録
リリースノート、変更履歴
軽量な書式が必要な長文コンテンツ

作成時の設定

データテーブルの「Configure fields」ページで「Add field」をクリックし、「Markdown」を選択すると、Markdown フィールドを作成できます。

20240512181311

設定	説明
Field interface	フィールドのインターフェースタイプ。Markdown の場合は `markdown` に対応し、ページ上での入力方法と表示方法を決定します。
Field display name	インターフェース上で表示されるフィールド名。「説明ドキュメント」「対応方案」「本文」などです。業務担当者がすぐに理解できる名称を使用することを推奨します。
Field name	API、リレーションフィールド、権限、ワークフローなどで内部的に参照するフィールド識別名です。作成後は通常変更せず、英字、数字、アンダースコアのみ使用でき、先頭は英字にする必要があります。
Field type	データレイヤーにおけるフィールドのタイプです。Markdown フィールドでは通常、内容の保存に `text` を使用します。
Default value	デフォルト値です。レコードの新規作成時にユーザーが入力しなかった場合、自動的に値を入力できます。
Validation rules	バリデーションルールです。文字数や必須入力などを制限できます。
Description	フィールドの説明です。フィールドの意味、入力要件、データソース、管理担当者などを記載するのに適しています。

注意

フィールド名は、作成後にページブロック、権限、ワークフロー、API から参照されます。作成前に命名を確認し、後からの変更による設定調整のコストを避けてください。

フィールドの特性

Markdown フィールドのデフォルト動作は次のとおりです。

特性	説明
デフォルトの Field interface	`markdown`。
デフォルトの Field type	`text`。
選択可能な Field type	`text`、`string`。実際のフィールド設定に準じます。
ページコンポーネント	編集モードでは Markdown 編集コンポーネントを使用します。
フィルター	含む、空、空ではないなど、テキスト向けのフィルターに対応しています。
並べ替え	通常、並べ替えには使用しません。
バリデーション	文字数や必須入力など、テキストに関するバリデーションに対応しています。

編集時の設定

作成後、フィールド右側の「Edit」をクリックすると、Markdown フィールドの設定を編集できます。フィールドの編集では、主に NocoBase におけるフィールドの表示方法や使用方法を調整します。たとえば、表示名、説明、デフォルト値、バリデーションルール、フィールド固有の設定などを変更できます。

フィールドがメインデータベースですでに同期されているテーブルに由来する場合、編集時には通常、フィールドマッピングを行います。これは、データベースのフィールドを NocoBase の Field type と Field interface にマッピングする操作です。

設定	編集可否	説明
Field display name	はい	インターフェース上で表示されるフィールド名を変更します。フィールド識別名は変更されません。
Field name	いいえ	フィールド識別名は、作成後通常、編集フォームでは変更できません。
Field interface	条件付きで可	メインデータベースのフィールドや同期フィールドは、フィールドマッピング時に調整できます。調整後は、ページ上での入力、表示、バリデーションの方法に影響します。
Field type	条件付きで可	メインデータベースのフィールドや同期フィールドは、フィールドマッピング時に調整できます。調整前に、既存のデータを新しいタイプで利用できるか確認する必要があります。
Default value	はい	レコードの新規作成時に使用するデフォルト値を調整します。
Validation rules	はい	フィールドのバリデーションルールを調整します。
Description	はい	フィールドの意味、入力要件、データソース、管理担当者などを補足します。

注意

Field type や Field interface の切り替えは、表示名を単に変更することとは異なります。フィールドの保存方法、入力コンポーネント、バリデーションルール、フィルター条件、ワークフロー変数の使用方法に影響します。既存データが多い場合は、データ形式が適合するか事前に確認してください。

フィールドの削除

フィールド右側の「Delete」をクリックすると、Markdown フィールドを削除できます。メインデータベースでは、複数のフィールドを選択して一括削除することもできます。

メインデータベースで新規作成した Markdown フィールドを削除すると、通常、データベース内の実際の列と、その列に保存されているデータも同時に削除されます。データベースとの同期や外部データソースからマッピングされたフィールドを削除する場合、影響範囲は対応するデータソースとフィールドの出所によって異なります。

警告

フィールドを削除すると、ページブロック、フォーム、フィルター、権限、ワークフロー、API、インポートとエクスポート、既存データに影響する可能性があります。削除前に、そのフィールドが現在も業務設定から参照されていないか確認してください。

ページ設定での使用

Markdown フィールドは、コンテンツの編集や詳細表示に適しています。 20260709230801

シーン	用途
フォームブロック	Markdown コンテンツを編集します。
詳細ブロック	Markdown としてレンダリングして表示します。
テーブルブロック	コンテンツの概要を表示します。
ワークフロー	本文を通知やドキュメント生成の内容として使用します。

#Markdown

#概要

#適用シーン

#作成時の設定

#フィールドの特性

#編集時の設定

#フィールドの削除

#ページ設定での使用

#関連リンク