Skip to content

Commit aa5ea3b

Browse files
committed
fix component heading formatting
1 parent a66ab27 commit aa5ea3b

File tree

2 files changed

+24
-24
lines changed

2 files changed

+24
-24
lines changed

apps/generator/docs/api_components.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ Generates both static and instance methods for sending messages through WebSocke
154154

155155

156156
<a name="CloseConnection"></a>
157-
## **CloseConnection()**
157+
## CloseConnection()
158158
Renders a WebSocket close connection method with optional pre- and post-execution logic.
159159

160160

@@ -210,7 +210,7 @@ renderCloseConnection();
210210

211211

212212
<a name="Connect"></a>
213-
## **Connect()**
213+
## Connect()
214214
Renders a WebSocket connection method for the specified programming language.
215215

216216

@@ -251,7 +251,7 @@ renderConnect();
251251

252252

253253
<a name="DependencyProvider"></a>
254-
## **DependencyProvider()**
254+
## DependencyProvider()
255255
Renders the top-of-file dependency statements for the selected programming language.
256256

257257

@@ -297,7 +297,7 @@ renderDependencyProvider();
297297

298298

299299
<a name="FileHeaderInfo"></a>
300-
## **FileHeaderInfo()**
300+
## FileHeaderInfo()
301301
Renders a file header with metadata information such as title, version, protocol, host, and path.
302302

303303

@@ -349,7 +349,7 @@ renderFileHeader().catch(console.error);
349349

350350

351351
<a name="HandleMessage"></a>
352-
## **HandleMessage()**
352+
## HandleMessage()
353353
Renders a WebSocket message handler method with optional pre- and post-execution logic.
354354

355355

@@ -407,7 +407,7 @@ renderHandleMessage();
407407

408408

409409
<a name="MethodGenerator"></a>
410-
## **MethodGenerator()**
410+
## MethodGenerator()
411411
Renders a language-specific formatted method definition.
412412

413413

@@ -474,7 +474,7 @@ renderMethodGenerator();
474474

475475

476476
<a name="Models"></a>
477-
## **Models()**
477+
## Models()
478478
Renders an array of model files based on the AsyncAPI document.
479479

480480

@@ -528,7 +528,7 @@ renderModel().catch(console.error);
528528

529529

530530
<a name="OnClose"></a>
531-
## **OnClose()**
531+
## OnClose()
532532
Renders a WebSocket onClose event handler for the specified programming language.
533533

534534

@@ -572,7 +572,7 @@ renderOnClose();
572572

573573

574574
<a name="OnError"></a>
575-
## **OnError()**
575+
## OnError()
576576
Renders a WebSocket onError event handler for the specified programming language.
577577

578578

@@ -608,7 +608,7 @@ renderOnError();
608608

609609

610610
<a name="OnMessage"></a>
611-
## **OnMessage()**
611+
## OnMessage()
612612
Renders a WebSocket onMessage event handler for the specified programming language.
613613

614614

@@ -644,7 +644,7 @@ renderOnMessage();
644644

645645

646646
<a name="OnOpen"></a>
647-
## **OnOpen()**
647+
## OnOpen()
648648
Renders a WebSocket onOpen event handler for the specified programming language.
649649

650650

@@ -688,7 +688,7 @@ renderOnOpen();
688688

689689

690690
<a name="QueryParamsVariables"></a>
691-
## **QueryParamsVariables()**
691+
## QueryParamsVariables()
692692
Renders query parameter variables code blocks.
693693

694694

@@ -747,7 +747,7 @@ renderQueryParamsVariable().catch(console.error);
747747

748748

749749
<a name="AvailableOperations"></a>
750-
## **AvailableOperations()**
750+
## AvailableOperations()
751751
Renders a list of AsyncAPI operations with their headers and message examples.
752752

753753

@@ -792,7 +792,7 @@ renderAvailableOperations().catch(console.error);
792792

793793

794794
<a name="CoreMethods"></a>
795-
## **CoreMethods()**
795+
## CoreMethods()
796796
Renders a list of core WebSocket client methods for a given target language.
797797

798798

@@ -828,7 +828,7 @@ renderCoreMethods();
828828

829829

830830
<a name="Installation"></a>
831-
## **Installation()**
831+
## Installation()
832832
Renders the Installation Command for a given language.
833833

834834

@@ -864,7 +864,7 @@ renderInstallation()
864864

865865

866866
<a name="MessageExamples"></a>
867-
## **MessageExamples()**
867+
## MessageExamples()
868868
Renders Message Examples of a given AsyncAPI operation.
869869

870870

@@ -912,7 +912,7 @@ renderMessageExamples().catch(console.error);
912912

913913

914914
<a name="OperationHeader"></a>
915-
## **OperationHeader()**
915+
## OperationHeader()
916916
Renders a header section for a single AsyncAPI operation.
917917

918918

@@ -960,7 +960,7 @@ renderOperationHeader().catch(console.error);
960960

961961

962962
<a name="Overview"></a>
963-
## **Overview()**
963+
## Overview()
964964
Renders an overview section for a WebSocket client.
965965
Displays the API description, version, and server URL.
966966

@@ -1018,7 +1018,7 @@ renderOverview().catch(console.error);
10181018

10191019

10201020
<a name="Readme"></a>
1021-
## **Readme()**
1021+
## Readme()
10221022
Renders a README.md file for a given AsyncAPI document.
10231023

10241024
Composes multiple sections (overview, installation, usage, core methods,
@@ -1077,7 +1077,7 @@ renderReadme().catch(console.error);
10771077

10781078

10791079
<a name="Usage"></a>
1080-
## **Usage()**
1080+
## Usage()
10811081
Renders a usage example snippet for a generated WebSocket client in a given language.
10821082

10831083

@@ -1121,7 +1121,7 @@ renderUsage();
11211121

11221122

11231123
<a name="RegisterErrorHandler"></a>
1124-
## **RegisterErrorHandler()**
1124+
## RegisterErrorHandler()
11251125
Renders a WebSocket error handler registration method with optional pre- and post-execution logic.
11261126

11271127

@@ -1174,7 +1174,7 @@ renderRegisterErrorHandler();
11741174

11751175

11761176
<a name="RegisterMessageHandler"></a>
1177-
## **RegisterMessageHandler()**
1177+
## RegisterMessageHandler()
11781178
Renders a WebSocket message handler registration method with optional pre- and post-execution logic.
11791179

11801180

@@ -1224,7 +1224,7 @@ renderRegisterMessageHandler();
12241224

12251225

12261226
<a name="SendOperations"></a>
1227-
## **SendOperations()**
1227+
## SendOperations()
12281228
Renders WebSocket send operation methods.
12291229
Generates both static and instance methods for sending messages through WebSocket connections.
12301230

packages/components/jsdoc2md-handlebars/api.hbs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ weight: 77
2222
{{#unless (eq name "ownKeys")}}
2323

2424
<a name="{{name}}"></a>
25-
## **{{name}}()**
25+
## {{name}}()
2626
{{description}}
2727

2828
{{#if params.length}}

0 commit comments

Comments
 (0)