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

feat: Added section leveling #90

Merged
merged 3 commits into from
Apr 28, 2021
Merged

feat: Added section leveling #90

merged 3 commits into from
Apr 28, 2021

Conversation

akabekobeko
Copy link
Member

@akabekobeko akabekobeko commented Apr 28, 2021

#8 で要望されていた機能のうち、

  • Pandoc では section 要素に class 属性 "level1" 〜 "level6" が出力される
    • これがあると CSS でレベルごとの section のスタイルを指定しやすいので、vfm にもほしい

へ対応してみました。懸念点として remark-attr の処理が走ると idclass の順番が入れ替わる謎の挙動があります。ただしこのプラグイン処理には関与できないのと HTML/CSS 的に属性の定義順へ強く依存するものはないと思われますので実用十分と判断しました。

これを先に実装したのは想定よりも影響範囲が少なくて済みそうであったためです。他の要望については別途、対応を検討します。

@MurakamiShinyu
ドキュメント docs/vfm.md とテスト test/section.test.ts についてレビューをお願いします。

@akabekobeko akabekobeko added this to the v1.0.0 milestone Apr 28, 2021
@akabekobeko akabekobeko self-assigned this Apr 28, 2021
Copy link
Member

@MurakamiShinyu MurakamiShinyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

よさそうだと思います。

細かなことを言うと、見出し h1-h6 は "Header" よりも "Heading" のほうが適切だと思います。

HTMLの仕様で h1-h6 は "heading" で header 要素は別のものです。

Markdownでの見出しについての説明でも、たいていは "heading" が使われています。
"header level 6" と "heading level 6" をそれぞれググって件数を比較すると "heading level 6" のほうが100倍くらい多いです。

しかし、元祖のMarkdown https://daringfireball.net/projects/markdown/basics を見たら、見出しのことを "header" と書かれてますね。なるほど、そこから Markdownの見出しのことが "header" と呼ばれているのだと、理解しました。
でもこの元祖Markdown以外のCommonMarkやGFMや多くのMarkdownの仕様書では "heading" が使われています。"heading" の語を使うようにしたほうがよいのでないでしょうか?

@akabekobeko
Copy link
Member Author

@MurakamiShinyu
提案ありがとうございます。見出しを示す部分で "Header" と表記していたものを "Heading" に変更してみました。確認をお願いします。

tests/math.test.ts Outdated Show resolved Hide resolved
Co-authored-by: Shinyu Murakami <murakami@vivliostyle.com>
@akabekobeko akabekobeko merged commit 67ddcec into master Apr 28, 2021
@akabekobeko akabekobeko deleted the feat-section-level branch April 28, 2021 12:54
@akabekobeko
Copy link
Member Author

うっかり余計な部分も変更してしまいました。指摘の変更を反映し、それ以外は OK とのことなので merge しました。レビューありがとうございました!

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