Skip to content

Commit

Permalink
Added mermaid diagrams.
Browse files Browse the repository at this point in the history
  • Loading branch information
RossBugginsNHS committed May 22, 2024
1 parent 584251d commit 3963460
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
17 changes: 17 additions & 0 deletions docs/user-guides/mermaid-diagrams.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 3963460

Please sign in to comment.