-
Type:
Task
-
Resolution: Won't Do
-
Priority:
Major - P3
-
None
-
Affects Version/s: None
-
Component/s: Tech debt
-
None
-
None
- We have a lot of context on implementation buried in our JS docs (e.g. import export) that would be valuable to productivity if discoverable. Scripts to include structured jsdoc in README.md's is the most direct for our workflows.
``` npm i --save-dev markdown-toc jsdoc2md node-injectmd ``` #### package.json scripts ``` "docs": "npm run docs:jsdoc && npm run docs:toc", "docs:toc": "markdown-toc -i README.md", "docs:jsdoc": "jsdoc2md -d 3 -c .jsdocrc lib/**/*.js | node-injectmd -t docs -i README.md", ``` #### README.md ``` md <!-- toc --> <!-- tocstop --> # Api ```