Document structure of parseable documentation markdown #402
Description
Even though this project's original goal is focussed around parsing the existing Node.js documentation, it would be valuable to start defining the specific ruleset it supports. For example, what is to a Class or Function definition? What goes into the section header, what are the necessary vs option subsections, etc.
I imagine that once we define the foundational ruleset for the existing Node.js docs, then we can iterate on it and adjust to support a different format and even become more general purpose. This would go hand in hand with linter rules and more specifically what kind of AST structure we want to declare.
In the past I experimented with this idea. What we are defining is really a subset of markdown. Since markdown itself is not very well defined we should make some declarations upfront like are we starting from GitHub Flavored Markdown or something else? I called my previous experiment "markdown documentation language" or "mddl" for short. You can see my WIP idea here.
It'd be my pleasure to start contributing to this initiative instead of continuing to create my own.