Markdown

markdown構成可能変数は、プロジェクト概要ページとHelix Coreサーバに保存されたファイルで、SwarmによってMarkdownでレンダリングが可能な構文を定義します。デフォルトでは、markdownはsafeに設定されています。Markdownテキストは表示されますが、未加工のHTMLとJavaScriptのコンテンツが実行されることを防ぐため、Markdownのサポートが制限されます。

ヒント

  • Markdownの有効なファイル拡張子は以下のとおりです。md、markdown、mdown、mkdn、mkd、mdwn、mdtxt、mdtext。

  • デフォルトでは、README Markdownファイルがプロジェクトのメインラインに存在する場合に、プロジェクト概要ページが表示されます。Swarmの管理者は、これを無効にすることができます。詳細については、「プロジェクトのReadmeファイル」を参照してください。
ヒント

構成情報を変更しても、構成キャッシュを再ロードしない限り、その構成情報がSwarmで使用されることはありません。構成キャッシュを再ロードすると、変更した構成情報がSwarmで強制的に使用されます。Swarm構成キャッシュを再ロードするには、admin ユーザまたはsuper ユーザでなくてはなりません。[ユーザID]ドロップダウンメニューに移動して[システム情報]を選択し、[キャッシュ情報]タブをクリックしてから[構成の再ロード]ボタンボタンをクリックします。

p4エントリと同じレベルで、以下の構成ブロックをSWARM_ROOT/data/config.phpファイルに追加します(すでに追加されている場合は、以下のように変更します)。

<?php
    // this block should be a peer of 'p4'
    'markdown' => array(
        'markdown' => 'safe', // default is 'safe'
    ),
  • safe: Markdownのコンテンツは表示されますが、未加工のHTMLとJavaScriptのコンテンツが実行されることを防ぐため、Markdownのサポートが制限されます。これがデフォルトの設定です。
  • unsafe: Markdownのサポートが制限されないため、完全なHTMLとJavaScriptを使用することができます。ただし、Swarmにアクセスできるすべてのユーザが、現在ログインしているユーザとして実行されるスクリプトをMarkdownに追加できるため、セキュリティ面で問題が発生する可能性があります。
  • disabled: Markdownテキストはレンダリングされず、プレーンテキスト形式で表示されます。これが、最も安全な設定です。
注意

コメントにMarkdownのコンテンツは表示されますが、未加工のHTMLとJavaScriptのコンテンツが実行されることを防ぐため、Markdownのサポートが制限されます。これはsafeモードと同等であり、変更することができません。