Package detail

mdx

rstacruz33.8kMIT0.3.1

Generic documentation extractor. Extensible enough to work with any language that supports comments.

comments, documentation, inline, markdown

readme

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.

changelog

v0.3.1

Dec 23, 2015

  • Fix extra newlines in long code blocks.

[v0.3.0]

Dec 23, 2015

  • Fix invocation using mdx -x tag file.js.
  • Add --json and -m/--markdown shorthand.

v0.2.3

Dec 22, 2015

  • Fix markdown including preludes.

v0.2.2

Dec 6, 2015

  • Fix syntax higlhighting, really.

v0.2.1

Dec 6, 2015

  • Fix syntax higlhighting.
  • Add preliminary support for CSS/Sass.

v0.2.0

Dec 6, 2015

  • Add a markdown field to blocks.
  • Changes code blocks into code fences.

v0.1.1

Aug 3, 2015

  • Implement --exclude-tag to filter certain tags from the output.

v0.1.0

Aug 3, 2015

  • Initial version.