Skip to content

Latest commit

 

History

History
18 lines (16 loc) · 568 Bytes

GENERATING_DOCS.md

File metadata and controls

18 lines (16 loc) · 568 Bytes

For each and every file under the ./src directory, run an isolated export command line as follows:

./node_modules/.bin/typedoc --entryDocument Home.md --hideBreadcrumbs true --hideInPageTOC true --cleanOutputDir false ./src/$FILE_NAME_HERE.ts

Remove the modules index file, then copy the results over to the wiki repository:

rm ./docs/modules.md
cp -r ./docs/* ../pocket-sockets.wiki/.

Updating the wiki repository:

cd ../pocket-sockets.wiki
git add .
git commit -S -m "Updating documentation to reflect latest code"
git push origin master