esl icon indicating copy to clipboard operation
esl copied to clipboard

[🚀site]: ts-doc based interactive documentation mechanism

Open ala-n opened this issue 3 years ago • 0 comments

As a dev ESL consumer, I want to see interactive detailed docs of ESL code.

It is requested to add the ability to insert autogenerated interactive docs sections on the demo pages.

Create a custom shortcut for templates, e.g. {# tsDoc 'src/module/all.ts' #}

  • Use passed root file to build TS project tree to parse TS Docs.
  • Pare the tree and aggregate Modules (files), Classes, Methods and Properties definition.
  • Render documentation using njk template and result definitions.

(Splitting candidate)

ala-n avatar Sep 03 '21 00:09 ala-n