Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support definition lists in Markdown #473

Merged
merged 1 commit into from
Dec 19, 2015

Conversation

murashitas
Copy link
Contributor

No description provided.

@murashitas
Copy link
Contributor Author

ごめんなさい! 手元のリポジトリで行おうとしたのに、間違えて本家にPRを送ってしまいました……申し訳ありません……

@takahashim
Copy link
Collaborator

あー、でもMarkdownのdefinition list記法はサポートしてないので、これをmergeさせてもらった方がいいでしょうか?
(HTMLタグを生成するよりもMultiMarkdown・PHP Markdown ExtraとかのDL記法の方がスマートですが、GFMだとこの記法はサポートしてないんですよね…)

@murashitas
Copy link
Contributor Author

これをmergeさせてもらった方がいいでしょうか?

可能であればそうしていただけるとありがたい(現在re:view→md2inaoみたいなのを個人的に実験しており、md2inaoにおいて定義リストはHTMLタグで表記しているため)……とは思うのですがが、↓の件でどのポリシーをとるかという話もありそうなので、「ぜひに!」というほどでもありません。

HTMLタグを生成するよりもMultiMarkdown・PHP Markdown ExtraとかのDL記法の方がスマートですが、GFMだとこの記法はサポートしてないんですよね…

このあたりのポリシーってあったりするのでしょうか? たぶん以下くらいの選択肢がありそうですね。

  1. GFMにないものはそもそもサポートしない
  2. GFMにないがHTMLで表現できるものであればHTMLで表記する(=今回のPR)
  3. GFMになくても、メジャーな拡張記法があればそれに変換する。メジャーな拡張記法がない場合はサポートしない
  4. GFMになくても、メジャーな拡張記法があればそれに変換する。メジャーな拡張記法がない場合でもHTMLで表現できるものであればHTMLで表記する

※「GFM」は「CommonMark」かも?

上述の実験の件とは関係なく、個人的には2推しではあります!

@takahashim
Copy link
Collaborator

Markdownビルダーについてのポリシーは現状はっきりとは決まっていないので、作りながら考える方向に今はなっています。
原則としては、他のビルダーで共通して使える記法はMarkdownビルダでも使えて然るべきかと思うので、実装はした方がよいかと思います。が、場合によっては、

  • 複数のビルダにわける(MarkdownBuilderとGFMBuilderとか)
  • config.ymlでどの拡張記法をサポートするかを指定できるようにする

といった対応もありえます。

あと、CommonMarkについては今のところ意識する必要はないかと思います。Re:VIEWはポリシーとして現場で動く・役に立つことを大事にしているため、まだ提案段階の仕様でしかないCommonMarkよりも、すでにあって使っているMarkdown処理系を利用するにあたって困ること・困ったことを解決する方向で考えるべきでしょう。

@murashitas
Copy link
Contributor Author

詳しく説明いただきありがとうございます! ↓がポイントなのですね。

すでにあって使っているMarkdown処理系を利用するにあたって困ること・困ったことを解決する方向で考えるべきでしょう。

今回のPRを取り込んでいただいても問題なさそうで、よかったです。よろしくお願いします 🙏

@takahashim
Copy link
Collaborator

とりあえず現状ではMarkdownビルダーでエラーが出ることは確認できたので、マージしますね

takahashim added a commit that referenced this pull request Dec 19, 2015
Support definition lists in Markdown
@takahashim takahashim merged commit 7616126 into kmuto:master Dec 19, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants