auto-generate documentation from JSDoc strings for timelines #38
auto-generate documentation from JSDoc strings for timelines #38cherriechang wants to merge 60 commits intomainfrom
Conversation
🦋 Changeset detectedLatest commit: 08846f7 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
…utils in list form
….js, filter-interfaces-docs.js and filter-timeline-docs.js
…dme.js script to copy over to main README
…nd-flowers; moved all scripts for update-readme into separate folder 'readme-scripts'; updated templates to reflect changes
…en files and nested directories as well
…xtension to suggest loading index.browser.js instead of index.global.js
…ge.json to use this package as devDependency
…ine-docs as dependency and run it as npm update-readme script
…plies path normalization
…st; keeps original file content if interface header not found; apply link normalization to all files
…s/; keeps original content if function not found; applies link normalization to all
…iables/ interfaces/
… that marks the start of the readme to append, adding ## createTimeline() Documentation as a heading if the provided heading does not include createTimeline() documentation in it
…dd typedoc.json to final exported package; first pass at readme
…lower than docStart (no replace)
… non-createtimeline, timelineunits, utils docs at the end
There was a problem hiding this comment.
Reviewed changes: added functionality of recursively building dependency graph between element documentations and printing them in order in readme; re-organized source code for generate-timeline-docs, moving each step in the pipeline to its own script and adding an index.js file that centralizes the actual running of the pipeline; added small fixes to new-extension, new-plugin and new-timeline; modified README files in new-timeline templates to work with generate-timeline-docs tool
|
It looks like merging this will make changes to the new-* packages as well. Do we need changesets for those changes? |
added changesets separately for new-* packages |
2 participants
@grouprouter option fromtypedocto group exports and theiroptionsinterfaces; but this is currently not supported intypescript-plugin-markdown