obsidianmd / jsoncanvas

An open file format for infinite canvas data.
https://jsoncanvas.org
MIT License
2.52k stars 83 forks source link

Specify content format more strictly #6

Open easrng opened 7 months ago

easrng commented 7 months ago

There are many incompatible markdown dialects. Consider switching to HTML or specifying a specific dialect, and define what to do when unsupported content is encountered.

nichtich commented 7 months ago

If interoperability is the main goal than CommonMark would be the best choice. As JSON Canvas is created by Obsidian, I guess the Markdown dialect is Obsidian Flavored Markdown . In theory this requires applications to recreate parts of Obsidian. Furthermore Obsidian Markdown seems to be extensible via plugins so perfectly processing arbitrary Canvas files from Obsidian seems to be impossible. In practice I bet each application will use its own preferred Markdown variant so there will be a mess as soon as you use non-trivial Markdown elements. Possible solutions:

  1. Agree on one Markdown dialect (this won't happen)
  2. Pray and guess when processing markdown
  3. Add a field to denote the markdown variant(s) used in a JSON Canvas file (e.g CommonMark or Obsidian + Citation-plugin) so the content can be processed e.g. with remark

I think solution 3 is most feasible to get 99% interoperability but only 1 would give 100% and in the end we will have 2 anyway as Markdown is not interoperable and people don't strictly follow standards (disclaimer: I'm a big fan of both Markdown, standards, and interoperability).

P.S: The JSON Canvas homepage seems to use it's own Markdown subset as well.