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

Interoperable YAML Schema? #227

Closed
elsiehupp opened this issue Sep 1, 2021 · 2 comments
Closed

Interoperable YAML Schema? #227

elsiehupp opened this issue Sep 1, 2021 · 2 comments

Comments

@elsiehupp
Copy link

As best I can tell, MultiMarkdown uses a subset of YAML for metadata headers. There's this guide section on the topic, but it's from MultiMarkdown 4, not MultiMarkdown 6.

The Markdown-based notes editor Joplin is currently in the process of working on YAML compatibility. Could you perhaps pop in and give your thoughts on interoperability with MultiMardown? (YAML aside, it would be nice to have some guidance on packaging multiple markdown files with attachments.)

Something I mentioned in the Joplin issue comment thread is the possibility of using Schema.org for metadata formatting. In the case of Joplin, this would most likely default to NoteDigitalDocument, but MultiMarkdown presumably supports a wider range of use cases. While the metadata fields supported by Schema.org are... quite numerous, MultiMarkdown and/or Joplin could choose their supported fields from the Schema.org list and define behavior for losslessly handling valid metadata fields that aren't supported by a particular client.

I guess, in summary:

  1. Can you coordinate with Joplin to some extent so that Joplin's exports can be agreeable with MultiMarkdown and vice versa?
  2. Can you provide perspective and guidance on packaging?
  3. Can you consider using Schema.org for defining standardized metadata fields? And,
  4. Can you update the MultiMarkdown guide for version 6 to define the current practices with regard to metadata headers?

Thanks!

@fletcher
Copy link
Owner

At this time I am not interested in modifying MultiMarkdown's metadata approach, nor does it require any sort of standardization. MultiMarkdown's metadata is designed to be flexible and support many different use cases. It's up to the user to decide whether to standardize on certain metadata keys.

As for interoperability, I believe the MultiMarkdown metadata syntax is fairly well documented, and there are a few test cases in the test suite.

I am happy to answer any specific questions that are sent my way.

@elsiehupp
Copy link
Author

No worries! Regardless, if you’d like you could stop by and say hi at the ongoing Joplin YAML initiative.

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

No branches or pull requests

2 participants