vivliostyle / vfm

⬇️ Open and extendable Markdown syntax and toolchain.
https://vivliostyle.github.io/vfm/#/vfm
Other
71 stars 12 forks source link

#67 Remove Fenced block and WAI-ARIA role from v1.0 #68

Closed akabekobeko closed 3 years ago

akabekobeko commented 3 years ago

67 を受けて Fenced block と WAI-ARIA role について以下の対応を実施しました。

ローカルでテストが通ることを確認済みです。

@MurakamiShinyu ざっと見ておかしいところがないか確認をお願いします。

akabekobeko commented 3 years ago

@MurakamiShinyu レビュー結果はいかがでしょうか?もし問題なければ merge します。

Fenced block については #5 でコメントしたように remark 13 系なら代替もあります。そのため VFM 2.0 では remark 13 ベースの remark-parse 9 系へ対応するついでにそれを導入する予定です。

本 PR では #67 が "Remove" となっていたので処理そのものを削除しました。しかし VFM 1.0 Alpha として Fenced block を利用していたかもしれないユーザーに配慮するとしたら実装を残して --exp-fenced-block のようなオプション付きで有効化し、正式対応の VFM 2.0 で標準化する方法も考えられます。

WAI-ARIA role については機能そのものの廃止を希望されており、その理由も妥当に思えるため削除でよいでしょう。

MurakamiShinyu commented 3 years ago

@akabekobeko レビュー遅くなってすみません。pull req の通知を見落としてたり、うっかり忘れてたりすることあるので、なかなか反応ないときは催促ください

MurakamiShinyu commented 3 years ago

@akabekobeko 関連して https://github.com/vivliostyle/themes/blob/master/DESIGN.md から該当仕様関連の記述を削除するのもお願いします。

MurakamiShinyu commented 3 years ago

本 PR では #67 が "Remove" となっていたので処理そのものを削除しました。しかし VFM 1.0 Alpha として Fenced block を利用していたかもしれないユーザーに配慮するとしたら実装を残して --exp-fenced-block のようなオプション付きで有効化し、正式対応の VFM 2.0 で標準化する方法も考えられます。

これまでのVFMは正式リリース前のAlpha版なので、オプション付きで有効にというのは不要だろうと思います。VFM 2.0 で remark-fenced-divs あるいは remark-directive を組み込むとして、それまでは Fenced block 機能なしでがまんしてもらえるでしょう。

このままマージしてよいと思います。

akabekobeko commented 3 years ago

@MurakamiShinyu レビューありがとうございました。

なかなか反応ないときは催促ください

はい。以後そうします。

https://github.com/vivliostyle/themes/blob/master/DESIGN.md から該当仕様関連の記述を削除するのもお願いします

これは role 部分でよいでしょうか?Fenced block については記述されていないようです。

それとドキュメント絡みだと https://vivliostyle.github.io/vfm/#/ があります。このページがどのリポジトリーでどのようにメンテナンスされているか教えていただければあわせて修正します。

MurakamiShinyu commented 3 years ago

@akabekobeko

https://github.com/vivliostyle/themes/blob/master/DESIGN.md から該当仕様関連の記述を削除するのもお願いします

これは role 部分でよいでしょうか?Fenced block については記述されていないようです。

はい ###rolefirst, then custom classes のところだけですね。 https://github.com/vivliostyle/themes/blob/master/DESIGN.md#role-first-then-custom-classes

それとドキュメント絡みだと https://vivliostyle.github.io/vfm/#/ があります。このページがどのリポジトリーでどのようにメンテナンスされているか教えていただければあわせて修正します。

この vfm リポジトリの /docs ディレクトリが GitHub Pages になってます(https://github.com/vivliostyle/vfm/settings で確認できます)。だから https://github.com/vivliostyle/vfm/blob/master/docs/vfm.md が更新されたので、すでに反映されています。

ところで、Hard new line https://github.com/vivliostyle/vfm/blob/master/docs/vfm.md#hard-new-line のところを直すのはまだこれからですね。

akabekobeko commented 3 years ago

@MurakamiShinyu

すでに反映されています。

ありがとうございます。反映されていることを確認しました。

ところで、Hard new line

これは #69 として対応したのでレビューをお願いします。

themes のほうは別途、PR 出します

akabekobeko commented 3 years ago

@MurakamiShinyu themes へ PR 出しておきました。