UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

github.com/loopbackio/loopback-next/tree/master/docs

loopbackio/loopback-next

74 lines (47 loc) • 1.57 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# @loopback/tsdocs This module provides [API docs](https://github.com/Microsoft/tsdoc) generation for `@loopback/*` packages. It's built on top of https://api-extractor.com/: - https://github.com/Microsoft/web-build-tools/tree/master/apps/api-extractor - https://github.com/Microsoft/web-build-tools/tree/master/apps/api-documenter ## Basic Use ### Build api reports and doc models ```sh npm run extract-apidocs -- --report ``` The command above will traverse all TypeScript packages in the monorepo and run `api-extractor` to generate api reports and doc models into `loopback-next/docs/apidocs`: - `reports`: api reports - `reports-temp`: temporary api reports - `models`: doc models ### Generate api docs as markdown files ```sh npm run document-apidocs ``` It runs `api-documenter` to generate markdown files into `loopback-next/docs/site/apidocs`. ### Update api docs for Jekyll site ```sh npm run update-apidocs ``` It adds Jekyll metadata to markdown files in `loopback-next/docs/site/apidocs` and generates `loopback-next/docs/site/apidocs/index.md` as the index page. To run all steps together: ```sh npm run build:tsdocs ``` ## Installation ```sh npm install --save @loopback/tsdocs ``` ## Contributions - [Guidelines](https://github.com/loopbackio/loopback-next/blob/master/docs/CONTRIBUTING.md) - [Join the team](https://github.com/loopbackio/loopback-next/issues/110) ## Tests Run `npm test` from the root folder. ## Contributors See [all contributors](https://github.com/loopbackio/loopback-next/graphs/contributors). ## License MIT