feat: markdownToHtml に `embedOrigin` オプションを追加した - Githubissues

zenn-dev / zenn-editor

Convert markdown to html in Zenn format

MIT License

626 stars 78 forks source link

feat: markdownToHtml に `embedOrigin` オプションを追加した #420

Closed uttk-dev closed 1 year ago

uttk-dev commented 1 year ago

:bookmark_tabs: Summary

埋め込み要素の挙動を上書きできるように markdownToHtml() に customEmbed オプションを追加しました
埋め込みサーバーのURLを含めないように markdownToHtml() に embedOrigin オプションを追加しました
実装を統一するためにリンクカードのパスを /link-card を /card に変更しました。
- 埋め込みサーバー側では対応済みなためリリースしても問題ありません
埋め込み要素のテストを追加しました

埋め込みサーバーを使う埋め込み要素のデフォルトの挙動について

embedOrigin を設定している場合は以前と同じ( zenn.dev と同じ ) 挙動になります。
- customEmbed も設定している場合は、customEmbedの方が優先されます
mermaid は、フロントエンド側でしかレンダリングできなかっためコードブロックをそのまま出力するようにしました
tweet は、サニタイズで script タグが埋め込めなかったためリンクをそのまま表示するようにしました
card・github・gist はリンクをそのまま表示するようしました

:clipboard: Tasks

プルリクエストを作成いただく際、お手数ですが以下の内容についてご確認をお願いします。

[x] :book: Contribution Guide を読んだ
[x] :woman_technologist: canary ブランチに対するプルリクエストである
[x] zenn-cli で実行して正しく動作しているか確認する
[x] 不要なコードが含まれていないか( コメントやログの消し忘れに注意 )
[x] XSS になるようなコードが含まれていないか
[x] モバイル端末での表示が考慮されているか
[x] Pull Reuqest の内容は妥当か( 膨らみすぎてないか )

より詳しい内容は Pull Request Policy を参照してください。