Skip to content

Commit 645ea6e

Browse files
shimksshimks
committed
docs: add sidebar and cli tables
1 parent 9a33f01 commit 645ea6e

File tree

3 files changed

+224
-0
lines changed

3 files changed

+224
-0
lines changed

‎docs/lb4_sidebar.yml

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
## definition of `menuitem`===========
2+
# title: string
3+
# url: string
4+
# output: [ enum{web, pdf} ] (expressed as comma separated string in YAML)
5+
# children?: [ menuitem ]
6+
7+
## top level property=================
8+
# entries: [ menuitem ]
9+
10+
title: LoopBack 4
11+
url: index.html
12+
children:
13+
14+
- title: 'Getting started'
15+
url: Getting-started.html
16+
output: 'web, pdf'
17+
children:
18+
19+
- title: 'Examples and tutorials'
20+
url: Examples-and-tutorials.html
21+
output: 'web, pdf'
22+
23+
- title: 'Key concepts'
24+
url: Concepts.html
25+
output: 'web, pdf'
26+
children:
27+
28+
- title: 'Application'
29+
url: Application.html
30+
output: 'web, pdf'
31+
32+
- title: 'Server'
33+
url: Server.html
34+
output: 'web, pdf'
35+
36+
- title: 'Context'
37+
url: Context.html
38+
output: 'web, pdf'
39+
40+
- title: 'Dependency injection'
41+
url: Dependency-injection.html
42+
output: 'web, pdf'
43+
44+
- title: 'Controllers'
45+
url: Controllers.html
46+
output: 'web, pdf'
47+
48+
- title: 'Routes'
49+
url: Routes.html
50+
output: 'web, pdf'
51+
52+
- title: 'Sequence'
53+
url: Sequence.html
54+
output: 'web, pdf'
55+
56+
- title: 'Model'
57+
url: Model.html
58+
output: 'web, pdf'
59+
60+
- title: 'Repositories'
61+
url: Repositories.html
62+
output: 'web, pdf'
63+
64+
- title: 'Decorators'
65+
url: Decorators.html
66+
output: 'web, pdf'
67+
68+
- title: 'Booting an Application'
69+
url: Booting-an-Application.html
70+
output: 'web, pdf'
71+
72+
- title: 'Using Components'
73+
url: Using-components.html
74+
output: 'web, pdf'
75+
76+
- title: 'Calling other APIs'
77+
url: Calling-other-APIs-and-web-services.html
78+
output: 'web, pdf'
79+
80+
- title: 'Testing your application'
81+
url: Testing-your-application.html
82+
output: 'web, pdf'
83+
84+
- title: 'For current LoopBack users'
85+
url: LoopBack-3.x.html
86+
output: 'web, pdf'
87+
88+
- title: 'Command-line interface'
89+
url: Command-line-interface.html
90+
output: 'web, pdf'
91+
children:
92+
93+
- title: 'Application generator'
94+
url: Application-generator.html
95+
output: 'web, pdf'
96+
97+
- title: 'Controller generator'
98+
url: Controller-generator.html
99+
output: 'web, pdf'
100+
101+
- title: 'Extension generator'
102+
url: Extension-generator.html
103+
output: 'web, pdf'
104+
105+
- title: 'Download examples'
106+
url: Download-examples.html
107+
output: 'web, pdf'
108+
109+
- title: 'Best practices with Loopback 4'
110+
url: Best-practices-with-Loopback-4.html
111+
output: 'web, pdf'
112+
children:
113+
114+
- title: 'Defining the API using code-first approach'
115+
url: Defining-the-API-using-code-first-approach.html
116+
output: 'web, pdf'
117+
118+
- title: 'Defining the API using design-first approach'
119+
url: Defining-the-API-using-design-first-approach.html
120+
output: 'web, pdf'
121+
children:
122+
123+
- title: 'Testing the API'
124+
url: Testing-the-API.html
125+
output: 'web, pdf'
126+
127+
- title: 'Defining your testing strategy'
128+
url: Defining-your-testing-strategy.html
129+
output: 'web, pdf'
130+
131+
- title: 'Implementing features'
132+
url: Implementing-features.html
133+
output: 'web, pdf'
134+
135+
- title: 'Preparing the API for consumption'
136+
url: Preparing-the-API-for-consumption.html
137+
output: 'web, pdf'
138+
139+
- title: 'Extending LoopBack 4'
140+
url: Extending-LoopBack-4.html
141+
output: 'web, pdf'
142+
children:
143+
144+
- title: 'Creating Components'
145+
url: Creating-components.html
146+
output: 'web, pdf'
147+
148+
- title: 'Creating Decorators'
149+
url: Creating-decorators.html
150+
output: 'web, pdf'
151+
152+
- title: 'Testing your extension'
153+
url: Testing-your-extension.html
154+
output: 'web, pdf'
155+
156+
- title: 'Crafting LoopBack 4'
157+
url: Crafting-LoopBack-4.html
158+
output: 'web, pdf'
159+
160+
- title: 'Language-related concepts'
161+
url: Language-related-concepts.html
162+
output: 'web, pdf'
163+
children:
164+
165+
- title: 'Mixin'
166+
url: Mixin.html
167+
output: 'web, pdf'
168+
169+
- title: 'FAQ'
170+
url: FAQ.html
171+
output: 'web, pdf'
172+
173+
- title: 'Reference'
174+
url: Reference.html
175+
output: 'web, pdf'
176+
children:
177+
178+
- title: 'Reserved binding keys'
179+
url: Reserved-binding-keys.html
180+
output: 'web, pdf'
181+
182+
- title: 'Glossary'
183+
url: Glossary.html
184+
output: 'web, pdf'

‎docs/tables/lb4-artifact-commands.html

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<table width="750">
2+
<thead><tr>
3+
<th width="200">Commands</th>
4+
<th>Description</th>
5+
<th width="200">See</th>
6+
</tr></thead>
7+
<tbody>
8+
<tr>
9+
<td><code>lb4 controller</code>
10+
</td><td> Add a new controller to a LoopBack 4 application
11+
</td><td> <a href="Controller-generator.html">Controller generator</a>
12+
</td></tr>
13+
14+
</tbody></table>

‎docs/tables/lb4-project-commands.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<table width="750">
2+
<thead><tr>
3+
<th width="200">Commands</th>
4+
<th>Description</th>
5+
<th width="200">See</th>
6+
</tr></thead>
7+
<tbody>
8+
<tr>
9+
<td><code>lb4</code>
10+
</td><td> Create a new LoopBack4 application
11+
</td><td> <a href="Application-generator.html">Application generator</a>
12+
</td></tr>
13+
14+
<tr>
15+
<td><code>lb4 extension</code>
16+
</td><td> Create a new LoopBack4 extension
17+
</td><td> <a href="Extension-generator.html">Extension generator</a>
18+
</td></tr>
19+
20+
<tr>
21+
<td><code>lb4 example</code>
22+
</td><td> Download one of LoopBack example projects
23+
</td><td> <a href="Download-examples.html">Download examples</a>
24+
</td></tr>
25+
26+
</tbody></table>

0 commit comments

Comments
 (0)