メインコンテンツにスキップ

Articles APIを使った公開記事のフォーマットとエクスポート方法

Help Centerの記事をArticles APIで適切にフォーマットするために必要なすべての情報

対応者:Beth-Ann Sher

Help Centerの記事をお客様にとって最も効果的で役立つものにするには、明確でスキャンしやすいフォーマットが必要です。これは記事エディター内またはArticles APIで簡単に実現できます。

この記事では、サポートされているフォーマットと、Articles APIで希望のスタイルを実現する方法を正確に示します。

注意:完全なAPIリファレンスガイドについては、開発者ドキュメントをご覧ください。

公開記事のフォーマット方法

本文のすべてのテキストは段落(p)タグ内に配置する必要があります:

<p>This is a paragraph</p>

段落内で改行を追加するには、改行(br)タグを使用します:

<p>This paragraph<br>has a line break in it</p>

記事でサポートされている見出しレベルは2つ、H1とH2です:

API経由で送信されたその他の見出しタグ(H3〜H6)は、階層を維持しつつH1とH2に変換されます。

<h1>This is a heading</h1>
<h2>This is a sub-heading</h2>

画像を追加するには、画像(img)タグを使用し、画像URLを“src”属性に指定します:

画像は指定したソースからIntercomにアップロードされ、記事内で表示するためにIntercomのリンクが使用されます。サポートされているファイル形式はPNG、JPEG、SVG、GIFです。

重要:画像のソースは完全なURL(例:https://examply.io/image.jpeg)でなければならず、相対URL(例:/image.jpeg)ではなく、ファイルは公開アクセス可能である必要があります。

<img src=”https://examply.io/image.jpeg”/>

プロのヒント:“alt”属性で画像の説明も含めるべきです。これにより記事のアクセシビリティが向上し、SEO効果もあります。

<img src=”https://examply.io/image.jpg” alt=”Examply project page”/>

<a href=”https://examply.io”>This is a text link</a>

リンクをボタンとして表示するには、“intercom-h2b-button”クラスを追加します:

<a href=”https://examply.io” class=”intercom-h2b-button”>This link is a button</a>

画像をリンクとして使用するには、リンクタグの間に配置します:

<a href=”https://examply.io”>
<img src=”https://examply.io/image_link.jpeg”/>
</a>

注意:“target”属性は不要です。記事内のすべてのリンクは新しいタブで開きます。

箇条書きリストと番号付きリストは、“unordered list (ul)”および“ordered list (ol)”タグで追加できます:

リスト内の各項目はリストアイテム(li)タグ内に配置する必要があります。

箇条書き(unordered)リスト:

<ul>
<li>First bulleted list item</li>
<li>Second bulleted list item</li>
</ul>

番号付き(ordered)リスト:

<ol>
<li>First numbered list item</li>
<li>Second numbered list item</li>
</ol>

ヒント:ネストされたリストの場合、別のリストアイテム内に“ol”または“ul”タグを含めます。

Youtube、Wistia、Vimeo、Loom、Vidyard、StreamIOの動画はiframeで追加できます:

<iframe src=”https://www.youtube.com/embed/jqO8AQHj7Fw”></iframe>

注意:動画の“src”属性には直接リンクではなく、embed URLを使用する必要があります。サポートされていないURLを送信するとAPIリクエストが失敗します。

コードはインラインまたは“pre”および“code”タグのコードブロックで追加できます。

コードブロック:

<pre><code>This is a code block, perfect for larger blocks of code</code></pre>

段落内のインラインコード:

<p>This paragraph contains some <code>inline code</code>.</p>

記事のスタイリング

太字には“b”または“strong”タグを使用します:

<p>This paragraph contains <b>bold words here</b> and <strong>here</strong></p>

斜体には“i”または“em”タグを使用します:

<p>This paragraph contains <i>italic words here</i> and <em>here</em></p>

注意:記事作成時、“strong”タグは“b”に、“em”タグは“i”に変換されます。

見出し、段落、画像、ボタンは中央揃えにできます

見出し、サブ見出し、段落

h1、h2、pタグに直接“intercom-align-center”クラスを追加します:

<h1 class=”intercom-align-center”>This heading is centered</h1>
<h2 class=”intercom-align-center”>So is this subheading</h2>
<p class=”intercom-align-center”>This paragraph is also centered.</p>

画像とボタン

画像やボタンを中央揃えにするには、“intercom-align-center”クラスを適用した“div”タグでラップする必要があります:

画像:

<div class="intercom-align-center">  <img src=”https://examply.io/image.jpg”/></div>

ボタン:

<div class="intercom-align-center">
<a class="intercom-h2b-button" href="https://examply.io">Centered Button</a>
</div>

重要:これらは唯一サポートされている“div”タグです。その他の“div”タグは段落タグに変換されます。

テーブル

“table”タグには少なくとも1行(“tr”)と1セル(“td”)が含まれている必要があります:

<table>
<tr>
<td>

</td>
</tr>
</table>

注意:

  • テーブルは他のテーブル内にネストできません。

  • theadtfoottbodyタグを送信した場合、その内容は通常の行として扱われます。

区切り線(水平ルール):

<hr>

サポートされていないものは?

Divとspan

送信された“div”または“span”タグはすべて“p”タグに置き換えられます。

注意:これはボタンや画像の中央揃えに使われるコンテナdivを除きます(上記参照)。

フォームと入力

“form”、“input”、“textarea”タグとその内容は記事本文から削除されます。

スクリプト

カスタムCSSやJavascriptの使用はサポートされていません。“script”タグとその内容は記事から削除されます。これにより、記事内のボタンはonclickハンドラーを使えず、スタイル付きリンクとして表示されますが、クリック時にJavaScriptは実行されません。Messengerをボタンから開くには、Intercomがインストールされたアプリ内のページにリンクし、そこでJavaScript(例:Intercom('show'))でMessengerを起動してください。

その他の要素

この記事に記載されていないタグや属性(“width”や“height”など)はすべて段落タグに置き換えられます。これには“head”、“html”、“footer”、“meta”などが含まれます。


Help Center記事のコンテンツエクスポート

IntercomのUIから記事をエクスポートすることはできませんが、APIドキュメントを使ってコンテンツをエクスポートできます。

こちらの回答で解決しましたか?