Skip to content

Commit d078f79

Browse files
committed
docs: move API.md to apps/generator/docs
1 parent 92de9ee commit d078f79

File tree

3 files changed

+11
-43
lines changed

3 files changed

+11
-43
lines changed
Lines changed: 5 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Reusable Components API
3+
weight: 77
4+
---
5+
16
<!-- markdownlint-disable MD024 -->
27
## Components
38

@@ -30,12 +35,6 @@
3035
<dd>
3136
<p>Renders a file header with metadata information such as title, version, protocol, host, and path.</p>
3237
</dd>
33-
<dt>
34-
<a href="#ownKeys">ownKeys</a>
35-
</dt>
36-
<dd>
37-
<p>Configuration for WebSocket message handler method logic per language.</p>
38-
</dd>
3938
<dt>
4039
<a href="#HandleMessage">HandleMessage</a>
4140
⇒ <code>JSX.Element</code>
@@ -153,25 +152,13 @@ provided AsyncAPI document, generator parameters, and target language.</p>
153152
<dd>
154153
<p>Renders a usage example snippet for a generated WebSocket client in a given language.</p>
155154
</dd>
156-
<dt>
157-
<a href="#ownKeys">ownKeys</a>
158-
</dt>
159-
<dd>
160-
<p>Configuration for WebSocket error handler registration method logic per language.</p>
161-
</dd>
162155
<dt>
163156
<a href="#RegisterErrorHandler">RegisterErrorHandler</a>
164157
⇒ <code>JSX.Element</code>
165158
</dt>
166159
<dd>
167160
<p>Renders a WebSocket error handler registration method with optional pre- and post-execution logic.</p>
168161
</dd>
169-
<dt>
170-
<a href="#ownKeys">ownKeys</a>
171-
</dt>
172-
<dd>
173-
<p>Configuration for WebSocket message handler registration method logic per language.</p>
174-
</dd>
175162
<dt>
176163
<a href="#RegisterMessageHandler">RegisterMessageHandler</a>
177164
⇒ <code>JSX.Element</code>
@@ -385,14 +372,6 @@ renderFileHeader().catch(console.error);
385372

386373

387374

388-
<a name="ownKeys"></a>
389-
## **ownKeys()**
390-
Configuration for WebSocket message handler method logic per language.
391-
392-
393-
394-
395-
396375
<a name="HandleMessage"></a>
397376
## **HandleMessage()**
398377
Renders a WebSocket message handler method with optional pre- and post-execution logic.
@@ -1165,14 +1144,6 @@ renderUsage();
11651144

11661145

11671146

1168-
<a name="ownKeys"></a>
1169-
## **ownKeys()**
1170-
Configuration for WebSocket error handler registration method logic per language.
1171-
1172-
1173-
1174-
1175-
11761147
<a name="RegisterErrorHandler"></a>
11771148
## **RegisterErrorHandler()**
11781149
Renders a WebSocket error handler registration method with optional pre- and post-execution logic.
@@ -1226,14 +1197,6 @@ renderRegisterErrorHandler();
12261197

12271198

12281199

1229-
<a name="ownKeys"></a>
1230-
## **ownKeys()**
1231-
Configuration for WebSocket message handler registration method logic per language.
1232-
1233-
1234-
1235-
1236-
12371200
<a name="RegisterMessageHandler"></a>
12381201
## **RegisterMessageHandler()**
12391202
Renders a WebSocket message handler registration method with optional pre- and post-execution logic.

packages/components/jsdoc2md-handlebars/api.hbs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Reusable Components API
3+
weight: 77
4+
---
5+
16
<!-- markdownlint-disable MD024 -->
27
## Components
38

packages/components/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"lint": "eslint --max-warnings 0 --config ../../.eslintrc --ignore-path ../../.eslintignore .",
1111
"lint:fix": "eslint --max-warnings 0 --config ../../.eslintrc --ignore-path ../../.eslintignore . --fix",
1212
"generate:assets": "npm run prepublishOnly && npm run docs",
13-
"docs": "jsdoc2md --helper \"jsdoc2md-helpers/jsdoc-helper.js\" --template \"jsdoc2md-handlebars/api.hbs\" \"./lib/**/*.js\" \"./lib/**/readme/*.js\" > docs/API.md"
13+
"docs": "jsdoc2md --helper \"jsdoc2md-helpers/jsdoc-helper.js\" --template \"jsdoc2md-handlebars/api.hbs\" \"./lib/**/*.js\" \"./lib/**/readme/*.js\" > ../../apps/generator/docs/api_components.md"
1414
},
1515
"files": [
1616
"lib/**",

0 commit comments

Comments
 (0)