-
Notifications
You must be signed in to change notification settings - Fork 3
Open
Labels
contributionExtra help highly appreciatedExtra help highly appreciateddocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
It will be better to have the API reference and a Table of Content inside the README.md.
The most efficient steps seem to be:
- Have the current content of
README.mdas a separate file (a.k.aREADME.base.md), with{{TOC}}and{{API}}placeholders. - Utilize the markdown-toc library to generate the TOC.
- A simple
string.replace()should be fine for this content insertion, because it is not complicated - no need to a dependency to yet another library just for that purpose. - It would be better to have the generate API content (which is currently dumped into
API.mdfile) be merged intoREADME.mdbefore the TOC generation, in order to have it's labels in as well. - Modify the
gulp'sdoctask in order to have this process properly handled.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
contributionExtra help highly appreciatedExtra help highly appreciateddocumentationImprovements or additions to documentationImprovements or additions to documentation