Home - nphyx/esdox GitHub Wiki
@nphyx/esdox 0.3.0
Clean, simple JSDoc -> Github Markdown generator with support for ES6+.
Author: Justen Robertson
License: MIT
Navigation
Modules
- main (in esdox.md)
- analyze (in lib/analyze.md)
- generateMD (in lib/generateMD.md)
Modules
Module main
Contains the main esdox module.
Functions
Module analyze
Helper functions for analyzing JSDoc ASTs.
Handles sorting, adding extra metadata, string escaping / cleanup, and other transforms of raw AST data for use by the mustache templates. These are all used internally and marked as private, but exported for unit testing purposes.
Module generateMD
The generateMD function, plus various internal functions to manage the process.