Merge pull request #13 from interledger/chj/add-mermaid-component

feat: add Mermaid component

Author: huijing

.gitignore

@@ -0,0 +1,133 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+# bun
+bun.lockb

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@interledger/docs-design-system",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "type": "module",
   "description": "Shared styles and components used across all Interledger Starlight documentation sites",
   "exports": {
@@ -18,5 +18,8 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/interledger/docs-design-system"
+  },
+  "devDependencies": {
+    "mermaid": "^10.6.1"
   }
 }

src/components/Mermaid.astro

@@ -0,0 +1,14 @@
+---
+interface Props {
+  graph: string;
+}
+
+const { graph } = Astro.props;
+---
+
+<pre class="mermaid" set:html={graph} />
+
+<script>
+  import mermaid from "../../node_modules/mermaid/dist/mermaid.esm.min.mjs";
+  mermaid.initialize({ startOnLoad: true });
+</script>

src/components/MermaidWrapper.astro

@@ -3,7 +3,7 @@ const { hasBorder = true } = Astro.props;
 ---
 <div>
   {hasBorder ? 
-    <div class="not-content border mermaid"><slot /></div> : 
+    <div class="not-content border mermaid-wrapper"><slot /></div> : 
     <div class="not-content"><slot /></div>
   }
   <button data-mermaid-button class="button">
@@ -17,9 +17,6 @@ div {
   margin-top: var(--space-m);
 }
 
-div :global(svg) {
-  background-color: white;
-}
 
 .border :global(svg) {
   border-radius: var(--border-radius);

src/index.ts

@@ -4,6 +4,7 @@ import Disclosure from "./components/Disclosure.astro";
 import Hidden from "./components/Hidden.astro";
 import LargeImg from "./components/LargeImg.astro";
 import LinkOut from "./components/LinkOut.astro";
+import Mermaid from "./components/Mermaid.astro";
 import MermaidWrapper from "./components/MermaidWrapper.astro";
 import StylishHeader from "./components/StylishHeader.astro";
 import Tooltip from "./components/Tooltip.astro";
@@ -14,6 +15,7 @@ export {
   Hidden,
   LargeImg,
   LinkOut,
+  Mermaid,
   MermaidWrapper,
   StylishHeader,
   Tooltip,

src/styles/ilf-docs.css

@@ -279,7 +279,7 @@
 
 /* Rounded corners and shadow flair */
 table,
-pre,
+pre:not(.mermaid),
 .starlight-aside,
 .img-outline,
 .expressive-code {
@@ -298,8 +298,6 @@ code {
 [aria-roledescription="sequence"] {
   background-color: white;
   border-radius: var(--border-radius);
-  box-shadow: var(--sl-shadow-sm);
-  border: 1px solid var(--sl-color-hairline-light);
 }
 
 /* Aside style overrides */