QiitaのMarkdownパーサー変更にともなう、補足説明の書き方と注意点


記事投稿シリーズについて

QiitaでGitHub Flavored Markdown (以下GFM) に準拠したMarkdownパーサーがベータ版として公開されました!

Qiitaアカウントによる説明記事にも書いてあるのですが、今までと記法が変わっている箇所があるので注意が必要です。
せっかく書いた記事の表示が崩れてしまうのは困るので、可能な限り防ぎたいと考えています!

そこで、記事を書く時に注意すべき記法などについて、Qiita運営から5日間に分けて10記事のシリーズで投稿することになりました!
少しでも皆様が執筆する際の助けになればと思います。

詳しくはQiitaアカウントによる説明記事に、投稿シリーズの説明や、他の記事一覧が載っていますのでぜひ他の記事も読んでみてください!

GFMの記法とは少し違いますが、この記事ではQiita独自の「補足説明のための記法(以下ノート記法)」について説明します。

ノート記法の説明

2021年7月21日にリリースしたQiita独自の記法です。

目を引く形で補足説明をしたい場合、補足したい内容を:::note info::: で囲みます。
補足したい内容と:::note info::: はそれぞれ別の行にする必要があります。
noteの後のinfoは省略可能です。
また、 noteの後にwarnをつけると警告メッセージとして、alertをつけるとより強い警告メッセージとして表現することができます。

:::note info
インフォメーション
infoは省略可能です。
:::

:::note warn
警告
○○に注意してください。
:::

:::note alert
より強い警告
○○しないでください。
:::

インフォメーション
infoは省略可能です。

警告
○○に注意してください。

より強い警告
○○しないでください。

パーサー変更にともなうアップデート

ノート記法の中で一部のマークダウンが使えるようになりました!

これまではプレーンなテキストと絵文字しか扱えませんでしたが、今回のアップデートにより以下をご使用いただけます!

  • リンク
  • 箇条書き
  • コード
  • 太字
  • 斜体
  • 打ち消し線
  • 画像

実際にノート記法の中で使ってみるとこのように見えます。

リンク

  1. 順序有りの箇条書き
  2. 順序有りの箇条書き
  3. 順序有りの箇条書き
  • 順序無しの箇条書き
  • 順序無しの箇条書き
  • 順序無しの箇条書き

code

太字

斜体

打ち消し線

画像↓

正確に言えば他のMarkdownの書き方も使えるのですが、現在は表示が崩れたり余白が空きすぎたりしてしまいます。
こちらは順次アップデートしていきますのでお待ちください

最後に

記事投稿シリーズはこちらの記事をもって完了です。

全て読んでいただいた方、ありがとうございます!
まだの方は、他の記法についてもQiitaアカウントによる説明記事でまとめていますので、合わせて読んでみてください!

また、Qiitaは今後も改善を続けていきます。
その中ではエディタの使い勝手向上や機能の追加も予定しており、皆さまに心地よく書いていただけるようにアップデートしていきます!

エディタを使ってみての感想も含め、Qiita Discussionsでいつでもお待ちしています。
ご意見がありましたら是非お寄せください!


↓記事投稿シリーズまとめ

↓前の記事