Skip to content

Commit bdfedca

Browse files
committed
replace backticks with code
1 parent 70cf706 commit bdfedca

File tree

3 files changed

+25
-25
lines changed

3 files changed

+25
-25
lines changed

apps/generator/docs/api_components.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,95 +5,95 @@ weight: 77
55

66
## Components
77

8-
* [CloseConnection](#CloseConnection)`JSX.Element`<br/>
8+
* [CloseConnection](#CloseConnection)<code>JSX.Element</code><br/>
99

1010
Renders a WebSocket close connection method with optional pre- and post-execution logic.
1111

12-
* [Connect](#Connect)`JSX.Element`<br/>
12+
* [Connect](#Connect)<code>JSX.Element</code><br/>
1313

1414
Renders a WebSocket connection method for the specified programming language.
1515

16-
* [DependencyProvider](#DependencyProvider)`JSX.Element`<br/>
16+
* [DependencyProvider](#DependencyProvider)<code>JSX.Element</code><br/>
1717

1818
Renders the top-of-file dependency statements for the selected programming language.
1919

20-
* [FileHeaderInfo](#FileHeaderInfo)`JSX.Element`<br/>
20+
* [FileHeaderInfo](#FileHeaderInfo)<code>JSX.Element</code><br/>
2121

2222
Renders a file header with metadata information such as title, version, protocol, host, and path.
2323

24-
* [HandleMessage](#HandleMessage)`JSX.Element`<br/>
24+
* [HandleMessage](#HandleMessage)<code>JSX.Element</code><br/>
2525

2626
Renders a WebSocket message handler method with optional pre- and post-execution logic.
2727

28-
* [MethodGenerator](#MethodGenerator)`JSX.Element`<br/>
28+
* [MethodGenerator](#MethodGenerator)<code>JSX.Element</code><br/>
2929

3030
Renders a language-specific formatted method definition.
3131

32-
* [Models](#Models)`Array.&lt;File&gt;`<br/>
32+
* [Models](#Models)<code>Array.&lt;File&gt;</code><br/>
3333

3434
Renders an array of model files based on the AsyncAPI document.
3535

36-
* [OnClose](#OnClose)`JSX.Element`<br/>
36+
* [OnClose](#OnClose)<code>JSX.Element</code><br/>
3737

3838
Renders a WebSocket onClose event handler for the specified programming language.
3939

40-
* [OnError](#OnError)`JSX.Element`<br/>
40+
* [OnError](#OnError)<code>JSX.Element</code><br/>
4141

4242
Renders a WebSocket onError event handler for the specified programming language.
4343

44-
* [OnMessage](#OnMessage)`JSX.Element`<br/>
44+
* [OnMessage](#OnMessage)<code>JSX.Element</code><br/>
4545

4646
Renders a WebSocket onMessage event handler for the specified programming language.
4747

48-
* [OnOpen](#OnOpen)`JSX.Element`<br/>
48+
* [OnOpen](#OnOpen)<code>JSX.Element</code><br/>
4949

5050
Renders a WebSocket onOpen event handler for the specified programming language.
5151

52-
* [QueryParamsVariables](#QueryParamsVariables)`Array.&lt;JSX.Element&gt;`<br/>
52+
* [QueryParamsVariables](#QueryParamsVariables)<code>Array.&lt;JSX.Element&gt;</code><br/>
5353

5454
Renders query parameter variables code blocks.
5555

56-
* [AvailableOperations](#AvailableOperations)`JSX.Element`<br/>
56+
* [AvailableOperations](#AvailableOperations)<code>JSX.Element</code><br/>
5757

5858
Renders a list of AsyncAPI operations with their headers and message examples.
5959

60-
* [CoreMethods](#CoreMethods)`JSX.Element`<br/>
60+
* [CoreMethods](#CoreMethods)<code>JSX.Element</code><br/>
6161

6262
Renders a list of core WebSocket client methods for a given target language.
6363

64-
* [Installation](#Installation)`JSX.Element`<br/>
64+
* [Installation](#Installation)<code>JSX.Element</code><br/>
6565

6666
Renders the Installation Command for a given language.
6767

68-
* [MessageExamples](#MessageExamples)`JSX.Element`<br/>
68+
* [MessageExamples](#MessageExamples)<code>JSX.Element</code><br/>
6969

7070
Renders Message Examples of a given AsyncAPI operation.
7171

72-
* [OperationHeader](#OperationHeader)`JSX.Element`<br/>
72+
* [OperationHeader](#OperationHeader)<code>JSX.Element</code><br/>
7373

7474
Renders a header section for a single AsyncAPI operation.
7575

76-
* [Overview](#Overview)`JSX.Element`<br/>
76+
* [Overview](#Overview)<code>JSX.Element</code><br/>
7777

7878
Renders an overview section for a WebSocket client. Displays the API description, version, and server URL.
7979

80-
* [Readme](#Readme)`JSX.Element`<br/>
80+
* [Readme](#Readme)<code>JSX.Element</code><br/>
8181

8282
Renders a README.md file for a given AsyncAPI document. Composes multiple sections (overview, installation, usage, core methods, and available operations) into a single File component based on the provided AsyncAPI document, generator parameters, and target language.
8383

84-
* [Usage](#Usage)`JSX.Element`<br/>
84+
* [Usage](#Usage)<code>JSX.Element</code><br/>
8585

8686
Renders a usage example snippet for a generated WebSocket client in a given language.
8787

88-
* [RegisterErrorHandler](#RegisterErrorHandler)`JSX.Element`<br/>
88+
* [RegisterErrorHandler](#RegisterErrorHandler)<code>JSX.Element</code><br/>
8989

9090
Renders a WebSocket error handler registration method with optional pre- and post-execution logic.
9191

92-
* [RegisterMessageHandler](#RegisterMessageHandler)`JSX.Element`<br/>
92+
* [RegisterMessageHandler](#RegisterMessageHandler)<code>JSX.Element</code><br/>
9393

9494
Renders a WebSocket message handler registration method with optional pre- and post-execution logic.
9595

96-
* [SendOperations](#SendOperations)`Array.&lt;JSX.Element&gt;`<br/>
96+
* [SendOperations](#SendOperations)<code>Array.&lt;JSX.Element&gt;</code><br/>
9797

9898
Renders WebSocket send operation methods. Generates both static and instance methods for sending messages through WebSocket connections.
9999

packages/components/jsdoc2md-handlebars/api.hbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 77
66
## Components
77

88
{{#functions}}
9-
* [{{name}}](#{{name}}){{#if returns.length}}`{{{escapeType returns.[0].type.names.[0]}}}`{{/if}}<br/>
9+
* [{{name}}](#{{name}}){{#if returns.length}}<code>{{{escapeType returns.[0].type.names.[0]}}}</code>{{/if}}<br/>
1010

1111
{{{description}}}
1212

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 --files \"./src/**/*.js\" \"./src/**/readme/*.js\" > ../../apps/generator/docs/api_components.md"
13+
"docs": "jsdoc2md --helper ./jsdoc2md-helpers/jsdoc-helper.js --template ./jsdoc2md-handlebars/api.hbs --files \"./src/**/*.js\" --files \"./src/**/readme/*.js\" > ../../apps/generator/docs/api_components.md"
1414
},
1515
"files": [
1616
"lib/**",

0 commit comments

Comments
 (0)