GROWI Docs

マークダウン設定

マークダウンの詳細は、以下のページで設定できます。

  • 管理ページ ＞ マークダウン設定(/admin/markdown ページへ遷移)

Line Break設定

GROWI のデフォルトの Markdown 記法では、単一の改行は<br>として扱われません。
単一の改行が<br>として扱われるようにするには、Line Break 設定で ON/OFF を切り替えます。

markdown_linebreak_1.png
  • Line Break 設定が有効の場合
    • ページテキストやコメント中の改行を、HTML内で<br>として扱います
markdown_linebreak_2.png
  • Line Break 設定が無効の場合
    • <br>を入力するか、半角スペースを2つ入れて改行します
markdown_linebreak_3.png

インデント設定

  • 管理者は、管理画面で以下の設定ができます。
    • 既定のインデント幅
    • ユーザーによるインデント幅の変更許可（ ON/OFF の切り替え）
markdown_indent_1.png
  • ユーザーによるインデント幅の変更を許可する設定にしている場合、
    ユーザーは、ページ編集画面の左下にある「エディタ設定」からインデントを選択することで、幅を指定できます。
markdown_indent_2.png

XSS(Cross Site Scripting)対策設定

マークダウンテキスト内の HTML タグの扱いを設定し、悪意のあるプログラムからの攻撃を防ぎます。
「おすすめ設定」と「カスタムホワイトリスト」のどちらかを選択できます。

markdown_xss_1.png

おすすめ設定

  • GROWI の利用には支障のない範囲で HTML を利用できるセキュアな設定です
  • ユーザーは設定値を変更できません
markdown_xss_2.png

カスタムホワイトリスト

  • どのような HTML タグ、タグ属性を許可するかを管理者自身で設定できます
  • タグ名
    • カンマ区切りのタグ名のリストを入力してください
  • タグ属性
    • JSON Object の string 表現を入力してください
    • JSON Object のキーにはタグ名、値には許可したいタグ属性の JSON Array の string 表現を入力してください
      • "*" をキーとすることで全てのタグに対して許可するタグ属性を指定できます

WARNING

v7.0.11 以前のバージョンにはカスタムホワイトリストに関するバグがあります

GROWI v6.0.0 から v7.0.11 までのバージョンではカスタムホワイトリストに関するバグが存在します。

症状
  • カスタムホワイトリストに入力した値が正常に反映されません
  • v7.0.10 以降にアップグレードするとこの問題が顕在化し、マークダウン中の HTML タグを正常にレンダリングできなくなる症状が発現します
関連する修正

#8836 (opens new window), #8946 (opens new window)

対処方法

以下のどちらかを実施してください。

  • おすすめ設定を利用する
  • v7.0.12 以降にアップグレードしカスタムホワイトリストを選択、タグ名・タグ属性ともにおすすめ設定の値をインポートし、それをベースに設定を変更する

設定例

空にすると全ての HTML タグおよびタグ属性を無効化します。

markdown_xss_3.png

たとえば、ページ本文に <h1>title</h1> のように記述しても、HTML が機能していないため、 h1 が「見出し 1 」として扱われません。

markdown_xss_4.png

もし、「タグ名」欄に h1 を追加した場合は、追加した HTML が機能します。

markdown_xss_5.png

HTML が機能しているため、 h1 が「見出し 1 」として扱われます。

markdown_xss_6.png

← セキュリティ設定 →