Updated the Yaml Generation to handle Multiline Description

Author: utkarshx

docs/api/browser/cb_index.md

@@ -41,13 +41,16 @@ cbapicategory:
     description: Takes a screenshot of the current page.
   - name: scroll
     link: scroll
-    description: Scrolls the current page in a specified direction by a specified number of pixels.
+    description: >-
+      Scrolls the current page in a specified direction by a specified number of
+      pixels.
   - name: search
     link: search
     description: Performs a search on the current page using a specified query.
   - name: type
     link: type
     description: Types text into a specified element on the page.
+
 ---
 # browser
 <CBAPICategory />

docs/api/cbstate/cb_index.md

@@ -2,7 +2,8 @@
 cbapicategory:
   - name: getApplicationState
     link: getApplicationState
-    description:  
+    description: ' '
+
 ---
 # cbstate
 <CBAPICategory />

docs/api/chat/cb_index.md

@@ -2,22 +2,23 @@
 cbapicategory:
   - name: eventEmitter
     link: eventEmitter
-    description:  
+    description: ' '
   - name: stopProcess
     link: stopProcess
-    description:  
+    description: ' '
   - name: getChatHistory
     link: getChatHistory
-    description:  
+    description: ' '
   - name: processStarted
     link: processStarted
-    description:  
+    description: ' '
   - name: sendMessage
     link: sendMessage
-    description:  
+    description: ' '
   - name: waitforReply
     link: waitforReply
-    description:  
+    description: ' '
+
 ---
 # chat
 <CBAPICategory />

docs/api/codeparsers/cb_index.md

@@ -9,6 +9,7 @@ cbapicategory:
   - name: getFunctionsinClass
     link: getFunctionsinClass
     description: Retrieves the functions in a given class within a file.
+
 ---
 # codeparsers
 <CBAPICategory />

docs/api/codeutils/cb_index.md

@@ -2,10 +2,11 @@
 cbapicategory:
   - name: getAllFilesAsMarkDown
     link: getAllFilesAsMarkDown
-    description:  
+    description: ' '
   - name: getCodeTree
     link: getCodeTree
     description: Asynchronously generates a code tree from the provided source code.
+
 ---
 # codeutils
 <CBAPICategory />

docs/api/constructor/cb_index.md

@@ -1,5 +1,6 @@
 ---
-cbapicategory:
+cbapicategory: []
+
 ---
 # constructor
 <CBAPICategory />

docs/api/crawler/cb_index.md

@@ -24,6 +24,7 @@ cbapicategory:
   - name: type
     link: type
     description: Types the provided text into an element with the specified ID.
+
 ---
 # crawler
 <CBAPICategory />

docs/api/dbmemory/cb_index.md

@@ -6,6 +6,7 @@ cbapicategory:
   - name: getKnowledge
     link: getKnowledge
     description: Retrieves a value from the in-memory database by key.
+
 ---
 # dbmemory
 <CBAPICategory />

docs/api/debug/cb_index.md

@@ -2,10 +2,11 @@
 cbapicategory:
   - name: debug
     link: debug
-    description:  
+    description: ' '
   - name: openDebugBrowser
     link: openDebugBrowser
-    description:  
+    description: ' '
+
 ---
 # debug
 <CBAPICategory />

docs/api/docutils/cb_index.md

@@ -3,6 +3,7 @@ cbapicategory:
   - name: pdf_to_text
     link: pdf_to_text
     description: Converts a PDF document to text.
+
 ---
 # docutils
 <CBAPICategory />

docs/api/fs/cb_index.md

@@ -2,25 +2,26 @@
 cbapicategory:
   - name: createFile
     link: createFile
-    description:  
+    description: ' '
   - name: createFolder
     link: createFolder
-    description:  
+    description: ' '
   - name: deleteFile
     link: deleteFile
-    description:  
+    description: ' '
   - name: deleteFolder
     link: deleteFolder
-    description:  
+    description: ' '
   - name: listFile
     link: listFile
-    description:  
+    description: ' '
   - name: readFile
     link: readFile
-    description:  
+    description: ' '
   - name: updateFile
     link: updateFile
-    description:  
+    description: ' '
+
 ---
 # fs
 <CBAPICategory />

docs/api/git/cb_index.md

@@ -2,7 +2,9 @@
 cbapicategory:
   - name: add
     link: add
-    description: Adds changes in the local repository to the staging area at the given path.
+    description: >-
+      Adds changes in the local repository to the staging area at the given
+      path.
   - name: branch
     link: branch
     description: Creates a new branch in the local repository at the given path.
@@ -14,10 +16,14 @@ cbapicategory:
     description: Clones a Git repository from the given URL to the specified path.
   - name: commit
     link: commit
-    description: Commits the staged changes in the local repository with the given commit message.
+    description: >-
+      Commits the staged changes in the local repository with the given commit
+      message.
   - name: diff
     link: diff
-    description: Retrieves the diff of changes for a specific commit in the local repository.
+    description: >-
+      Retrieves the diff of changes for a specific commit in the local
+      repository.
   - name: init
     link: init
     description: Initializes a new Git repository at the given path.
@@ -26,13 +32,18 @@ cbapicategory:
     description: Retrieves the commit logs for the local repository at the given path.
   - name: pull
     link: pull
-    description: Pulls the latest changes from the remote repository to the local repository at the given path.
+    description: >-
+      Pulls the latest changes from the remote repository to the local
+      repository at the given path.
   - name: push
     link: push
-    description: Pushes local repository changes to the remote repository at the given path.
+    description: >-
+      Pushes local repository changes to the remote repository at the given
+      path.
   - name: status
     link: status
     description: Retrieves the status of the local repository at the given path.
+
 ---
 # git
 <CBAPICategory />

docs/api/knowledge/cb_index.md

@@ -1,5 +1,6 @@
 ---
-cbapicategory:
+cbapicategory: []
+
 ---
 # knowledge
 <CBAPICategory />

docs/api/llm/cb_index.md

@@ -2,8 +2,8 @@
 cbapicategory:
   - name: inference
     link: inference
-    description: Sends an inference request to the LLM and returns the model's response.
-The model is selected based on the provided 
+    description: "Sends an inference request to the LLM and returns the model's response.\r\nThe model is selected based on the provided "
+
 ---
 # llm
 <CBAPICategory />

docs/api/outputparsers/cb_index.md

@@ -2,14 +2,14 @@
 cbapicategory:
   - name: init
     link: init
-    description: Initializes the output parser module.
-Currently, this function does not perform any operations.
+    description: "Initializes the output parser module.\r\nCurrently, this function does not perform any operations."
   - name: parseErrors
     link: parseErrors
     description: Parses the given output and returns all the error messages.
   - name: parseWarnings
     link: parseWarnings
     description: Parses the given output and returns all the warning messages.
+
 ---
 # outputparsers
 <CBAPICategory />

docs/api/project/cb_index.md

@@ -5,8 +5,8 @@ cbapicategory:
     description: Retrieves the path of the current project.
   - name: getProjectSettings
     link: getProjectSettings
-    description: Placeholder for a method to get project settings.
-Currently, this method does not perform any operations.
+    description: "Placeholder for a method to get project settings.\r\nCurrently, this method does not perform any operations."
+
 ---
 # project
 <CBAPICategory />

docs/api/rag/cb_index.md

@@ -9,6 +9,7 @@ cbapicategory:
   - name: retrieve_related_knowledge
     link: retrieve_related_knowledge
     description: Retrieves related knowledge for a given query and filename.
+
 ---
 # rag
 <CBAPICategory />

docs/api/search/cb_index.md

@@ -9,6 +9,7 @@ cbapicategory:
   - name: search
     link: search
     description: Performs a search operation for the given query.
+
 ---
 # search
 <CBAPICategory />

docs/api/start_browser/cb_index.md

@@ -1,5 +1,6 @@
 ---
-cbapicategory:
+cbapicategory: []
+
 ---
 # start_browser
 <CBAPICategory />

docs/api/taskplaner/cb_index.md

@@ -9,6 +9,7 @@ cbapicategory:
   - name: updateTask
     link: updateTask
     description: Updates an existing task using a WebSocket message.
+
 ---
 # taskplaner
 <CBAPICategory />

docs/api/terminal/cb_index.md

@@ -2,22 +2,20 @@
 cbapicategory:
   - name: eventEmitter
     link: eventEmitter
-    description:  
+    description: ' '
   - name: executeCommand
     link: executeCommand
-    description: Executes a given command and returns the result.
-Listens for messages from the WebSocket that indicate the output, error, or finish state
-of the executed command and resolves the promise accordingly.
+    description: "Executes a given command and returns the result.\r\nListens for messages from the WebSocket that indicate the output, error, or finish state\r\nof the executed command and resolves the promise accordingly."
   - name: executeCommandRunUntilError
     link: executeCommandRunUntilError
-    description: Executes a given command and keeps running until an error occurs.
-Listens for messages from the WebSocket and resolves the promise when an error is encountered.
+    description: "Executes a given command and keeps running until an error occurs.\r\nListens for messages from the WebSocket and resolves the promise when an error is encountered."
   - name: executeCommandWithStream
     link: executeCommandWithStream
-    description:  
+    description: ' '
   - name: sendManualInterrupt
     link: sendManualInterrupt
-    description:  
+    description: ' '
+
 ---
 # terminal
 <CBAPICategory />

docs/api/tokenizer/cb_index.md

@@ -3,6 +3,7 @@ cbapicategory:
   - name: addToken
     link: addToken
     description: Adds a token asynchronously.
+
 ---
 # tokenizer
 <CBAPICategory />

docs/api/userMessageListener/cb_index.md

@@ -1,5 +1,6 @@
 ---
-cbapicategory:
+cbapicategory: []
+
 ---
 # userMessageListener
 <CBAPICategory />

docs/api/vectordb/cb_index.md

@@ -9,6 +9,7 @@ cbapicategory:
   - name: queryVectorItem
     link: queryVectorItem
     description: Queries a vector item from the vector database based on the provided key.
+
 ---
 # vectordb
 <CBAPICategory />

docs/api/waitForConnection/cb_index.md

@@ -1,5 +1,6 @@
 ---
-cbapicategory:
+cbapicategory: []
+
 ---
 # waitForConnection
 <CBAPICategory />

docs/api/websocket/cb_index.md

@@ -1,5 +1,6 @@
 ---
-cbapicategory:
+cbapicategory: []
+
 ---
 # websocket
 <CBAPICategory />

scripts/jsdoc_to_docusaurus.js

@@ -63,11 +63,12 @@ function writeToFile(filePath, frontMatterVars){
 }
 
 function writeClassIndex(categoryName, indexFilePath, classAllFrontMatters) {
-  let classIndexContent = '---\ncbapicategory:\n';
-  
-  classAllFrontMatters.forEach(frontMatter => {
-    classIndexContent += `  - name: ${frontMatter.data.name}\n    link: ${frontMatter.data.name}\n    description: ${frontMatter.cbbaseinfo.description}\n`;
-  });
+  let classIndexContent = '---\n';
+  classIndexContent += `${yaml.dump({ cbapicategory: classAllFrontMatters.map(frontMatter => ({
+    name: frontMatter.data.name,
+    link: frontMatter.data.name,
+    description: frontMatter.cbbaseinfo.description
+  }))})}\n`;
   classIndexContent += `---\n# ${categoryName}\n<CBAPICategory />\n`;
   fs.writeFileSync(indexFilePath, classIndexContent);
 }