File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1+ ---
2+ name : TypeDoc
3+
4+ on :
5+ push :
6+ branches :
7+ - master
8+
9+ jobs :
10+ typedoc :
11+ runs-on : ubuntu-latest
12+ steps :
13+ - uses : actions/checkout@v2
14+ - name : Use Node.js v16.x
15+ uses : actions/setup-node@v2
16+ with :
17+ node-version : v16.x
18+ - name : Generate
19+ run : |
20+ npm i -g typedoc
21+ yarn install --frozen-lockfile
22+ typedoc
23+ - name : Deploy
24+ uses : JamesIves/github-pages-deploy-action@4.1.5
25+ with :
26+ branch : typedoc
27+ folder : ./typedoc
Original file line number Diff line number Diff line change 11# ## App
2- /dist /
2+ /dist
3+ /typedoc
34
45# ## Node
56# Logs
Original file line number Diff line number Diff line change @@ -52,15 +52,6 @@ This project uses TypeScript. To create javascript sources run:
5252yarn run build
5353```
5454
55- To generate the documentation, use typedoc:
56-
57- ``` sh
58- npm install -g typedoc
59- typedoc
60- ```
61-
62- and copy the result inside this README.
63-
6455## Testing
6556
6657To run the test suite, first install the dependencies, then run ` yarn test ` :
Original file line number Diff line number Diff line change 11{
2- "out" : " docs " ,
2+ "out" : " typedoc " ,
33 "name" : " node-java-props Documentation" ,
44 "entryPoints" : [" src/typedoc.d.ts" ],
55 "exclude" : [" src/utils.ts" ],
You can’t perform that action at this time.
0 commit comments