リッチテキストエディタ

  • GitLab 14.0でWikiに導入されました
  • GitLab 15.5で、content_editor_on_issuesというフラグでイシューの説明を編集するために導入されました。デフォルトでは無効。
  • GitLab 15.11で、ディスカッションやイシューの作成・編集、マージリクエストに同じフラグが導入されました。
  • GitLab 16.1で同じフラグでエピックに導入
  • 機能フラグcontent_editor_on_issues GitLab 16.2ではデフォルトで有効。

フラグ: セルフマネジメントのGitLabでは、デフォルトでこの機能が利用可能です。この機能を隠すには、管理者がcontent_editor_on_issuesという機能フラグを無効にします。GitLab.comでは、この機能は利用可能です。

リッチテキストエディタは、”what you see is what you get”(WYSIWYG) エディタなので、GitLab Flavored Markdownの構文をすべて覚えていなくても、説明やコメントで使うことができます。

Rich text editor in GitLab

リッチテキストエディタは

エディタの機能は以下の通りです:

  • 太字、斜体、ブロック引用符、見出し、インラインコードなどのテキストの書式設定。
  • 順序付きリスト、順序なしリスト、チェックリストの書式設定
  • リンク、添付ファイル、画像、ビデオ、オーディオの挿入。
  • テーブル構造の作成と編集
  • シンタックスハイライトを使ったコードブロックの挿入と書式設定
  • Mermaid、PlantUML、Krokiダイアグラムをリアルタイムでプレビュー。

リッチテキストエディタを GitLab 全体のより多くの場所に追加する作業を追跡するには、エピック 7098 をご覧ください。

リッチテキストエディタに切り替える

リッチテキストエディタを使用して、説明文、Wikiページ、コメントの追加を編集します。

リッチテキストエディタに切り替えるには: テキストボックスの左下で、リッチテキスト編集に切り替えるを選択します。

プレーンテキストエディタへの切り替え

テキストボックスにMarkdownソースを入力したい場合は、プレーンテキストエディタの使用に戻ってください。

プレーン・テキスト・エディタに切り替えるには: テキスト・ボックスの左下で、プレーン・テキスト編集に切り替えるを選択します。

GitLabフレーバーMarkdownとの互換性

リッチテキストエディタはGitLab Flavored Markdownと完全な互換性があります。つまり、データを失うことなく、プレーンテキストモードとリッチテキストモードを切り替えることができます。

入力ルール

リッチテキストエディタは、Markdownを入力するようにリッチコンテンツを扱うことができる入力規則もサポートしています。

サポートされている入力規則

入力規則の構文挿入内容
# Heading 1

###### Heading 6
見出し1~6
**bold** または__bold__ 太字
_italics_ または*italics* イタリック体
~~strike~~取り消し線
[link](url)ハイパーリンク
codeインラインコード
``rb +Enter
```js +Enter
コードブロック
* List itemまたは
- List itemまたは
+ List item
順序なしリスト
1. List item番号付きリスト
<details>折りたたみセクション

テーブル

生のMarkdownとは異なり、リッチテキストエディタを使用して、テーブルセルにブロックコンテンツの段落、リストアイテム、ダイアグラム(あるいは別のテーブル!)を挿入することができます。

表の挿入

表を挿入するには

  1. テーブルの挿入 {テーブル}を選択します。
  2. ドロップダウン・リストから、新しいテーブルの寸法を選択します。

Alt text

テーブルの編集

表のセル内では、メニューを使って行や列を挿入したり削除したりすることができます。

メニューを開くにはセルの右上隅で、シェブロン{シェブロン・ダウン}を選択します。

Alt text

複数のセルに対するオペレーション

複数のセルを選択し、マージまたは分割します。

選択したセルを1つにマージします:

  1. 複数のセルを選択 - 1つを選択し、カーソルをドラッグします。
  2. セルの右上隅で、シェブロン{シェブロンダウン}を選択します。> セルをマージします。

マージしたセルを分割するにはセルの右上隅で、シェブロン{シェブロン-下}を選択します。> セルを分割します。

図の挿入

MermaidおよびPlantUMLダイアグラムを挿入し、ダイアグラムのコードを入力しながらライブでプレビューできます。

ダイアグラムを挿入するには

  1. テキスト・ボックスの一番上のバーで、{プラス}を選択します。選択し、Mermaid ダイアグラムまたはPlantUML ダイアグラムを選択します。
  2. ダイアグラムのコードを入力します。ダイアグラムのプレビューがテキスト・ボックスに表示されます。

Mermaid diagrams in rich text editor