From e9d07933a8aec0c76754c6756cc8b6ce5ef97fc8 Mon Sep 17 00:00:00 2001 From: Chen Hui Jing <1461498+huijing@users.noreply.github.com> Date: Wed, 29 Nov 2023 19:43:24 +0800 Subject: [PATCH] Add Mermaid component --- .gitignore | 133 ++++++++++++++++++++++++++++ package.json | 5 +- src/components/Mermaid.astro | 14 +++ src/components/MermaidWrapper.astro | 5 +- src/index.ts | 2 + src/styles/ilf-docs.css | 4 +- 6 files changed, 155 insertions(+), 8 deletions(-) create mode 100644 .gitignore create mode 100644 src/components/Mermaid.astro diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3d87167 --- /dev/null +++ b/.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 diff --git a/package.json b/package.json index f9dd432..11d7d8f 100644 --- a/package.json +++ b/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" } } diff --git a/src/components/Mermaid.astro b/src/components/Mermaid.astro new file mode 100644 index 0000000..aa7f623 --- /dev/null +++ b/src/components/Mermaid.astro @@ -0,0 +1,14 @@ +--- +interface Props { + graph: string; +} + +const { graph } = Astro.props; +--- + +
+
+
diff --git a/src/components/MermaidWrapper.astro b/src/components/MermaidWrapper.astro
index 53e123b..68e0397 100644
--- a/src/components/MermaidWrapper.astro
+++ b/src/components/MermaidWrapper.astro
@@ -3,7 +3,7 @@ const { hasBorder = true } = Astro.props;
 ---
 
{hasBorder ? -
: +
:
}