(小ネタ)backlogの表は先頭に特殊文字が入っていると崩れるのでエスケープしよう

タイトル通りBacklogの表は先頭に特殊文字が入っていると崩れます。表が崩れた際には、バックスラッシュ(\)を使ってエスケープ処理をしましょう。
2023.09.15

こんにちは!AWS事業本部のおつまみです。

みなさん、プロジェクト管理ツールのbacklogは使っていますか?私は毎日使っています。

backlogにはwiki機能があり、パラメータ値などを表にまとめる際に利用しています。
その表のプレビューが崩れてしまい、30分ほど解決に時間を費やしてしまったので、対応方法をご紹介します。

いきなり結論

  • backlogの表は先頭に特殊文字(*,¥など)が入っていると崩れる。
  • 特殊文字の前にバックスラッシュ(\)を入れて、エスケープ処理をしましょう。

Backlogの表について

Backlog で表を作成する際は、Markdown記法での作成が可能です。
以下のように記載することで表を作成できます。

| インスタンス名 | キーペア | Elastic IP | プライベートIP | 備考 |
| --- | --- | --- | --- | --- |
| sample-env-ec2 | sample-env-key | xx.xx.xx.xx | xx.xx.xx.xx |  |

崩れてしまったケース

表の先頭に特殊文字(*,¥など)が入っていると表が崩れてしまいます。

| インスタンス名 | キーペア | Elastic IP | プライベートIP | 備考 |
| --- | --- | --- | --- | --- |
| sample-env-ec2 | sample-env-key |  *xx.xx.xx.xx | xx.xx.xx.xx |  |

そのため特殊文字の前にバックスラッシュ(\)を入れて、エスケープ処理をします。

| インスタンス名 | キーペア | Elastic IP | プライベートIP | 備考 |
| --- | --- | --- | --- | --- |
| sample-env-ec2 | sample-env-key |  \*xx.xx.xx.xx | xx.xx.xx.xx |  |

対象の特殊文字の確認は以下のサイトをご参考ください。

特殊文字のエスケープ - IBM Documentation

さいごに

今回はbacklogの表が崩れてしまった時の対処方法をお伝えしました。

Backlog記法でうまくいかなかった場合、以下のブログも参考にしてください。

最後までお読みいただきありがとうございました!
どなたかのお役に立てれば幸いです。

以上、おつまみ(@AWS11077)でした!

参考資料

テキスト整形のルール (Markdown 記法) – Backlog ヘルプセンター

Markdown記法 チートシート - Qiita