QiitaのMarkdownパーサーの変更をベータ版として公開します
こんにちは、Qiita運営です。
今日はQiitaのMarkdownパーサーの変更をベータ版としてリリースすることをお知らせします。
リリースは2022年2月9日を予定しています。
Markdownパーサーの変更について
これまでのQiitaでは、Redcarpetを拡張したGreenmatを用いてMarkdownのパースを行っていました。
今回のベータ版リリースでは、CommonMarkerを拡張したQiita Markerへ変更いたします。
パーサーの変更によって細かな違いはありますが、基本的なパース結果は今までと変わりありません。
記法の変更箇所についての詳細は、Qiita運営による解説記事で説明予定ですので、あわせてご確認ください。
ベータ版では、以下のコンテンツを新規作成、もしくは編集をする際に新しいMarkdownパーサーでパースされます。
- 記事
- コメント
- 質問
- 回答
既存の記事、コメント、質問、回答は以前のパース結果を保持しているため、編集を行わない限りは変化はありません。
注意点
過去データの保持について
現時点では、少なくとも約1年間は過去のパース結果を保持する方針ですのでご安心ください。
しかし、今後何らかの事情によりすべてのコンテンツを再度パースする必要が出てくるかもしれません。
編集を行っていないコンテンツのパース結果も更新されるため、過去記事の確認をお願いする可能性もあります。
ユーザーの皆様にはお手数をおかけしますが、確認や更新をしやすいようにサポートを実施する予定ですのでご協力いただけますと幸いです。
執筆済みのコンテンツの更新について
パーサーの変更によって出力されるHTMLが変わってしまう箇所がいくつかあります。
お手数をおかけしますが、対象のコンテンツを編集する際には、プレビューでのご確認をお願いいたします。
記法の変更箇所についての詳細は、Qiita運営による解説記事で説明予定ですので、あわせてご確認ください。
編集する際には以下のようなメッセージが出ますので、表示された際は変更していない部分も含めてご確認をお願いいたします。
また、記事の編集リクエストを受け取った際もプレビューでの確認をお願いいたします。
もし、ベータ版リリース期間中に以前のMarkdownパーサーに戻したい場合は、ベータ版を無効化していただき再度編集を行うことで戻すことができます。
以前のパーサーによるパース結果への復元はベータ版の期間中のみ可能となりますので、できる限り新しいMarkdownパーサーをご利用いただくことをおすすめいたします。
変更の背景
現在、Qiita運営ではQiitaのエディタには品質・体験ともに改善の必要があると感じています。
ユーザーの皆様からも多くの声を頂いており、2021年10月に一部のQiitaユーザーに実施したユーザーインタビューでもエディタの課題点が見えてきました。
しかしエディタの改善を進めるにあたり、現状のMarkdownパーサーのままでは改善が難しい課題があったため、Markdownパーサーの変更に踏み切りました。
2022/2/9 追記 「エディタを改善するためのMarkdownパーサーアップデート」について
エディタ改善の1つとして、編集エリアとプレビューのスクロール位置を同期させる改善を行う予定です。
従来のMarkdownパーサーではこちらの実現が難しいことが分かったため、今回アップデートを実施しました。
正確なリリース時期は未定ですが、現在編集エリアとプレビューのスクロール位置を同期させるための開発を行っております。
今後について
冒頭にも記載した通り、2022年2月9日にまずはベータ版としてMarkdownパーサーの変更をリリースいたします。
ぜひ一度ご利用いただき、フィードバックをいただけますと幸いです。
ベータ版として公開後、いただいたフィードバックをもとに機能の改善を行い正式リリース予定です。
正式リリースの日程については、追ってQiita BlogやQiita Discussionsにてお知らせいたします。
これからもQiitaの改善に取り組んでいきます。
もし、ご意見・ご要望がありましたらQiita Discussionsよりいつでもお寄せください。
Q&A
Q. 使っているMarkdownパーサーを見分ける方法はありますか?
A. UI上で見分ける方法はありません。ベータ版を有効にしている状態で該当コンテンツの編集中にプレビューを行うと、新しいパーサーでパースされた結果が表示されるようになっています。
Q. ベータ版公開期間に来た編集リクエストはどのMarkdownパーサーでパースされますか?
A. 編集リクエストを送信した人がベータ版を有効にしているかどうかに限らず、受信した人のベータ版の状態によってパーサーが決まります。そのため編集リクエストを送信する際には新しいパーサーでプレビューされていない可能性もありますので、採用する際には必ずプレビューでご確認をお願いします。
Q. ベータ版公開期間に限定共有記事を公開する際に注意することはありますか?
A. 公開前にもう一度記事の更新をすることをおすすめします。限定共有記事を公開する際にパーサーが変更になり、表示が崩れる可能性もあるためです。