aws / aws/graph-explorer

Add mermaid diagram rendering to docs site

Open
#1,760 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement internal
Dominant language
TypeScript
Stars
481
Forks
108
Avg merge
6d 8h
Merged PRs (30d)
5

Description

## Description

The `references/architecture.md` page contains a mermaid diagram that renders as a plain code block in Starlight. Starlight does not render mermaid diagrams by default.

## Solution

Add the `rehype-mermaid` plugin (or `@astrojs/starlight-mermaid`) to the Astro config so that ```mermaid``` code blocks render as diagrams.

## Acceptance Criteria

- Mermaid code blocks in documentation render as SVG diagrams
- The docs build still passes
- No additional client-side JavaScript is required (use server-side rendering)

## Related Issues

- Parent #1754

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.