fletcher / MultiMarkdown-4

This project is now deprecated. Please use MultiMarkdown-6 instead!
https://github.com/fletcher/MultiMarkdown-5
Other
307 stars 59 forks source link

Allow to enclose metadata in html comments #69

Closed memeplex closed 10 years ago

memeplex commented 10 years ago

Maybe with a special marker as in

<!-- Meta:
.....
.....
-->

This way you're able to use metadata locally and then post the document asis to, say, github.

fletcher commented 10 years ago

Metadata doesn't break documents when viewing in renderer that only supports Markdown. I guess I don't see why this would be necessary??

In general, properly formatted metadata looks the same in plain text or in HTML, so it's actually useful when it's included as is.

memeplex commented 10 years ago

The problem is not that the document breaks but that the metadata is shown. Locally I use custom metadata to instruct my scripts to generate pdf or html, to include mathjax support or not, to include codehilite support or not, etc. I often use the standard mm metadata too. This is fine when I'm editing/previewing a github/bitbucket wiki/readme locally but, after that, github/bitbucket engine is in charge and the metadata becomes visible. This is data about data, not intended for the final reader to see it. Encapsulating it inside a html comment ensures source compatibility across markdown renderers (obviously using the "universal" subset of mm).

fletcher commented 10 years ago

I guess in the end, my thought is that MultiMarkdown is not Markdown. Metadata is not a feature of Markdown, it's a feature of MultiMarkdown.

If the renderer you are using is not actually appropriate to the document type (e.g. being forced to use a Markdown renderer for a MultiMarkdown document), then it only makes sense that the document will not appear as you originally desired.

I'm not sure that this approach is the right way to go --- adding additional complexity so that documents break in one way but not another way when processed with the wrong parser.

IMHO, a better approach is to petition github to support MultiMarkdown. ;)

memeplex commented 10 years ago

Ok, no problem, I'm just using my own trivial metadata syntax and parser, but I thought it would be good to take advantage of mm's.