markdown documentation language
mddl is a subset of markdown. It adds no new features to markdown, but adds additional rules so it is easier to author JavaScript documentation.
mddl looks like this:
# Object: FetchOptions
An object containing any custom settings you want to apply to the request.
Parameters:
* **method** - `string` - _optional_ - Default: `'GET'` - The request method, e.g., `"GET"`, `"POST"`
* **headers** - `Headers | Record<string, string>` - _optional_ - Any headers you want to add to your request.
<!-- ...etc. -->
mddl is very early in development. It is currently not published to any registry. Enable notifications for this repo and follow @ArrowoodTech on Twitter for latest updates.
@mddl/spec- complete specification for mddl@mddl/ast- AST forms and types@mddl/from-mdast- mdast to@mddl/asttransformer package.
Inside of @mddl/from-mdast is an example.js you can run locally. Give it a try!
This project was originally inspired by Electron Docs style-guide.