/mdx

Documentation extractor [WIP]

Primary LanguageJavaScript

@rstacruz/mdx

Generic documentation extractor.

  • Should extensible to work with any language that supports comments
  • Outputs documentation in JSON format
  • Prefers Markdown

Status

Currently only supports JavaScript, more languages to come later.

Available in npm as @rstacruz/mdx (as of Oct 2018). Previously it was under mdx, but this package name was donated to the mdx-js organization.

Thanks

@rstacruz/mdx © 2015-2018, Rico Sta. Cruz. Released under the MIT License.
Authored and maintained by Rico Sta. Cruz with help from contributors (list).

ricostacruz.com  ·  GitHub @rstacruz  ·  Twitter @rstacruz