docs: adjust API.md templates to keep </dd> inline and prevent website break (#1748)

Co-authored-by: lightning-sagar <lightningsagar0@gmail.com>
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>

Author: lightning-sagar

.gitattributes

@@ -1,3 +1,8 @@
 # Ensure script files have LF line endings
 *.sh text eol=lf
 *.bash text eol=lf
+
+# Normalize documentation and templates
+*.md text eol=lf
+*.hbs text eol=lf
+*.js text eol=lf

apps/generator/docs/api.md

@@ -8,15 +8,14 @@ Reference API documentation for AsyncAPI Generator library.
 
 <dl>
 <dt><a href="#Generator">Generator</a></dt>
-<dd></dd>
 </dl>
 
 ## Members
 
 <dl>
 <dt><a href="#listBakedInTemplates">listBakedInTemplates</a> ⇒ <code>Array.&lt;Object&gt;</code></dt>
 <dd><p>List core templates, optionally filter by type, stack, protocol, or target.
-Use name of returned templates as input for the <code>generate</code> method for template generation. Such core templates code is part of the @asyncapi/generator package.</p></dd>
+Use name of returned templates as input for the `generate` method for template generation. Such core templates code is part of the @asyncapi/generator package.</p></dd>
 </dl>
 
 

apps/generator/docs/jsdoc2md-handlebars/main-index/global-index/global-index-dl.hbs

@@ -0,0 +1,13 @@
+{{#globals kind=kind ~}}
+{{#if @first~}}{{>heading-indent}}{{../title}}
+
+<dl>
+{{/if~}}
+<dt>{{>sig-link-html}}</dt>
+{{#if description~}}
+<dd><p>{{{inlineLinks description}}}</p></dd>
+{{/if}}
+{{#if @last~}}</dl>
+
+{{/if~}}
+{{/globals~}}

apps/generator/package.json

@@ -18,7 +18,7 @@
     "test:integration": "npm run test:cleanup && jest --testPathPattern=integration --modulePathIgnorePatterns='./__mocks__(?!\\/loglevel\\.js$)'",
     "test:integration:update": "npm run test:integration -- -u",
     "test:cleanup": "rimraf \"test/temp\"",
-    "docs": "jsdoc2md --partial docs/jsdoc2md-handlebars/custom-sig-name.hbs docs/jsdoc2md-handlebars/main.hbs docs/jsdoc2md-handlebars/header.hbs docs/jsdoc2md-handlebars/defaultvalue.hbs docs/jsdoc2md-handlebars/link.hbs docs/jsdoc2md-handlebars/params-table.hbs docs/jsdoc2md-handlebars/member-index-list.hbs docs/jsdoc2md-handlebars/member-index-grouped.hbs docs/jsdoc2md-handlebars/members.hbs --files lib/generator.js > docs/api.md",
+    "docs": "jsdoc2md --partial \"docs/jsdoc2md-handlebars/**/*.hbs\" --files lib/generator.js > docs/api.md",
     "docker:build": "docker build -t asyncapi/generator:latest .",
     "lint": "eslint --max-warnings 0 --config ../../.eslintrc --ignore-path ../../.eslintignore .",
     "lint:fix": "npm run lint -- --fix",