From 3963460c36dd7828069951e8bee2abc57e1e727b Mon Sep 17 00:00:00 2001
From: Ross Buggins <ross.buggins@nhs.net>
Date: Wed, 22 May 2024 14:27:24 +0100
Subject: [PATCH] Added mermaid diagrams.

---
 docs/_config.yml                     | 23 +++++++++++++++++++++++
 docs/user-guides/mermaid-diagrams.md | 17 +++++++++++++++++
 2 files changed, 40 insertions(+)
 create mode 100644 docs/user-guides/mermaid-diagrams.md

diff --git a/docs/_config.yml b/docs/_config.yml
index baaf9f6..75a7561 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -38,6 +38,29 @@ header_pages:
   - about.md
 
 color_scheme: nhs
+mermaid:
+  # Version of mermaid library
+  # Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
+  version: "10.9.1"
+
+aux_links:
+  "NHS Notify on GitHub":
+    - "//github.com/NHSDigital/nhs-notify"
+
+aux_links_new_tab: false
+
+# Footer "Edit this page on GitHub" link text
+gh_edit_link: true # show or hide edit this page link
+gh_edit_link_text: "Edit this page on GitHub."
+gh_edit_repository: "https://github.com/NHSDigital/nhs-notify" # the github URL for your repo
+gh_edit_branch: "main" # the branch that your docs is served from
+# gh_edit_source: docs # the source that your files originate from
+gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
+
+callouts:
+  warning:
+    title: Warning
+    color: red
 
 # Exclude from processing.
 # The following items will not be processed, by default.
diff --git a/docs/user-guides/mermaid-diagrams.md b/docs/user-guides/mermaid-diagrams.md
new file mode 100644
index 0000000..5058b37
--- /dev/null
+++ b/docs/user-guides/mermaid-diagrams.md
@@ -0,0 +1,17 @@
+---
+layout: default
+title:  Mermaid Diagrams
+parent: User Guides
+---
+
+## Guide: Perform static analysis
+
+- [Guide: Perform static analysis](#guide-perform-static-analysis)
+- [Overview](#overview)
+
+## Overview
+
+```mermaid
+flowchart TB
+    A & B--> C & D
+```