資料 > 資料-1. マークダウン記法

資料-1. マークダウン記法

OpsAidでは、受信したアラートをインシデントとして管理する際に、インシデントの対応状況としてコメントを追加することができます。

追加するコメントには、マークダウン記法を利用することができます。

以下に、OpsAidで利用可能なマークダウン記法を示します。

見出し

先頭に シャープ を記載します。
シャープの数で、見出しのレベルを変更できます。(1〜6)

記述例

# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6

表示例

箇条書きリスト

先頭に ハイフンプラスアスタリスク のいずれかを記述します。
ハイフン等の前に半角スペース4つを入れるとネストになります。

記述例

- リスト1
    - リスト1_1 ネストは半角スペース4つ
        - リスト1_1_1
        - リスト1_1_2
    - ネスト リスト1_2
+ リスト2
* リスト3

表示例

番号付きリスト

先頭に (半角数字)(半角ドット) と記述します。数字は任意です。
同じインデントの要素が同じリストとして扱われ、自動的に番号が割り振られます。

記述例

1. 番号付きリスト1
    1. 番号付きリスト1-1
    1. 番号付きリスト1-2
        1. 番号付きリスト1-2-1
1. 番号付きリスト2
1. 番号付きリスト3

表示例

引用

先頭に > を記述します。
重ねて使うと二重引用になります。

記述例

> 先程の問い合わせですが、こちらに詳細がありました。
> 
> > こちらのページをご確認ください。
> > 
> > https://sample.help.com/aaa/
>
> 以上です。

表示例

pre記法

コード等を直接記述したい場合は、先頭に半角スペースを4つ挿入します。

記述例

貼り付け用サンプルコード

    class Sample
        def test():
            print("これはサンプルです。")

表示例

code記法

文中にコードの一部を記述する場合は、バッククォート(``)で囲みます。

記述例

実行するコマンドは `service restart` です。

表示例

強調(<em>)

半角アスタリスクまたは半角アンダースコア1つで囲んだ箇所を斜体で強調します。

記述例

ここを *強調* します

_こちら_ も強調します

表示例

強調(<strong>)

半角アスタリスクまたは半角アンダースコア2つで囲んだ箇所を太字で強調します。

記述例

ここを **強調** します

__こちら__ も強調します

表示例

強調(<em>+<strong>)

半角アスタリスクまたは半角アンダースコア3つで囲んだ箇所を斜体+太字で強調します。

記述例

ここを ***強調*** します

___こちら___ も強調します

表示例

水平線

半角ハイフンを3個以上記述すると、水平線を表示します。

記述例

上の項目

---

下の項目

--- 同じ行に他の文字列があると水平線にはならない

表示例

リンク

[表示名](リンク先URL)と入力することで、リンクになります。

記述例

[Googleへジャンプ](https://www.google.com/)

表示例

インシデントのコメントで利用できるマークダウン記法のご紹介は以上になります。

インシデントにコメントを追加する方法については、 スタートガイド > 2. 受け取ったアラートを詳しく知ろう > 2-1. 起票されたインシデントを見よう をご覧ください。