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

Reduce inconsistency about html option between Marp and Marpit #111

Closed
exKAZUu opened this issue Oct 4, 2019 · 1 comment · Fixed by #117
Closed

Reduce inconsistency about html option between Marp and Marpit #111

exKAZUu opened this issue Oct 4, 2019 · 1 comment · Fixed by #117

Comments

@exKAZUu
Copy link

exKAZUu commented Oct 4, 2019

Marp constructor ignores markdown.html option (c.f. https://github.com/marp-team/marp-core#html-boolean--object), but, Marpit constrcutor accepts markdown.html option (c.f. https://github.com/marp-team/marpit/blob/master/docs/usage.md#-markdown-it-parser-setting)

I feel this structure is a bit confusing. Could we unify markdown.html v.s. html ?

@yhatt yhatt transferred this issue from marp-team/marpit Oct 4, 2019
@yhatt
Copy link
Member

yhatt commented Oct 4, 2019

Transferred issue from Marpit ▶️ Marp Core 🚚

Surely it's confusable. Internally Marp Core's html option has already become just an alias to markdown.html by working at #74. It may be better to unify interface into markdown.html and match to Marpit.

Background

Marp Core has an extra feature that there is not in Marpit, to sanitize HTML by whitelist if JSON was passed to html.

The reason why splitted options into html and markdown.html in Marp Core was afraid breaking compatibility with the other markdown-it plugins, because typically markdown-it's html option does allow boolean value only.

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 a pull request may close this issue.

2 participants