Currently help files are xmls with a complicated schema. The analogy is
.1 man files (but much more verbose).
Idea of platyPS project: instead of editing xml files directly, let’s author CommonMark files in a particular way (with all necessary information) and generate this xml help files as a build step.
It enables a simple collaboration story: MD is easy to edit in the browser on GitHub.
For the broader description see the platyPS announcement.
We called this particular way to author MD files a schema.
I tried to find any project that formalize the idea of markdown schema, but didn’t succeed.
We came up with a loose way to describe it.
- Markdown was designed to be rendered as html. Is our approach (another way to render it) something generally acceptable/useful?
- Does it make sense to formalize the concept of MD schema? If yes, what’s the good way to describe such schema?