From 878c9f1d9db8c964669b3e99364eac611659e41e Mon Sep 17 00:00:00 2001
From: Pedro Reyes <prodtos2@gmail.com>
Date: Mon, 6 Mar 2023 19:32:34 -0300
Subject: [PATCH] Add documentation for exposed detectType function

---
 docs/config/usage.md                      | 17 +++++++++++++++++
 packages/mermaid/src/docs/config/usage.md | 17 +++++++++++++++++
 2 files changed, 34 insertions(+)

diff --git a/docs/config/usage.md b/docs/config/usage.md
index 190ef2197..1069ffa5f 100644
--- a/docs/config/usage.md
+++ b/docs/config/usage.md
@@ -247,6 +247,23 @@ The example below show an outline of how this could be used. The example just lo
 </script>
 ```
 
+To determine the type of diagram present in a given text, you can utilize the `mermaid.detectType` function, as demonstrated in the example below.
+
+```html
+<script type="module">
+  import mermaid from './mermaid.esm.mjs';
+  const graphDefinition = `sequenceDiagram
+    Pumbaa->>Timon:I ate like a pig.
+    Timon->>Pumbaa:Pumbaa, you ARE a pig.`;
+  try {
+    const type = mermaid.detectType(graphDefinition);
+    console.log(type); // 'sequence'
+  } catch (error) {
+    // UnknownDiagramError
+  }
+</script>
+```
+
 ### Binding events
 
 Sometimes the generated graph also has defined interactions like tooltip and click events. When using the API one must
diff --git a/packages/mermaid/src/docs/config/usage.md b/packages/mermaid/src/docs/config/usage.md
index c74023952..211a06af7 100644
--- a/packages/mermaid/src/docs/config/usage.md
+++ b/packages/mermaid/src/docs/config/usage.md
@@ -244,6 +244,23 @@ The example below show an outline of how this could be used. The example just lo
 </script>
 ```
 
+To determine the type of diagram present in a given text, you can utilize the `mermaid.detectType` function, as demonstrated in the example below.
+
+```html
+<script type="module">
+  import mermaid from './mermaid.esm.mjs';
+  const graphDefinition = `sequenceDiagram
+    Pumbaa->>Timon:I ate like a pig.
+    Timon->>Pumbaa:Pumbaa, you ARE a pig.`;
+  try {
+    const type = mermaid.detectType(graphDefinition);
+    console.log(type); // 'sequence'
+  } catch (error) {
+    // UnknownDiagramError
+  }
+</script>
+```
+
 ### Binding events
 
 Sometimes the generated graph also has defined interactions like tooltip and click events. When using the API one must