Skip to content

Commit

Permalink
Merge pull request #977 from alphagov/diagrams
Browse files Browse the repository at this point in the history
Moved quote attributions to outside of quotes
  • Loading branch information
james-sheppard-gov-uk authored Jan 9, 2025
2 parents 9b7e025 + 288e76e commit 9b4e0e4
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions source/standards/diagrams-as-code.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Code can be used to define the content, structure and appearance of a diagram wh
## What are diagrams for?

> A good diagram enables you to more easily convey your design to others, and it provides a focus for your creative, as well as your technical thinking.

— [Drawing good architecture diagrams](https://www.ncsc.gov.uk/blog-post/drawing-good-architecture-diagrams) tips from NCSC

There are many ways to create a diagram, from pen and paper or whiteboard through to specialist diagramming software. The right tool will depend on the circumstances, including what the diagram is for and who needs to be able to contribute to it, but it's always worth considering a diagram generated from code.
Expand Down Expand Up @@ -38,6 +39,7 @@ Assuming you already [use GitHub](https://gds-way.digital.cabinet-office.gov.uk/
The [Mermaid Live Editor](https://mermaid.live/) is a good way of trying out Mermaid, and seeing diagrams rendered from code in real time.

> Mermaid will automatically insert the aria-roledescription and, if provided in the diagram text by the diagram author, the accessible title and description.

— [Mermaid Accessibility Options](https://mermaid.js.org/config/accessibility.html)

This works in a similar way to the `alt` attribute of an `<img>` element.
Expand Down

0 comments on commit 9b4e0e4

Please sign in to comment.