Add some credit comments

pasqal-io · Feb 14, 2025 · 53e68c7 · 53e68c7
1 parent 3996700
commit 53e68c7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/packages/starlight-client-mermaid/index.ts b/packages/starlight-client-mermaid/index.ts
@@ -79,6 +79,9 @@ export default function starlightClientMermaid(
   };
 }
 
+// Overrides a Starlight component, with warning and instructions
+// in case it was already overriden in user config.
+// Credit: https://github.com/HiDeoo/starlight-blog/blob/94d156f50321c94a8f8af8a916ddcd08082f807d/packages/starlight-blog/index.ts#L119-L136
 function overrideStarlightComponent(
   components: StarlightUserConfig["components"],
   logger: AstroIntegrationLogger,

diff --git a/packages/starlight-client-mermaid/scripts/remarkTagMermaid.ts b/packages/starlight-client-mermaid/scripts/remarkTagMermaid.ts
@@ -1,3 +1,7 @@
+// Remark plugin to transform Mermaid codeblocks in Markdown
+// into HTML divs with the raw Mermaid code in data attribute
+// Adapted from https://github.com/JuanM04/portfolio/blob/983b0ed0eabdac37bf8b7912d3e8128a443192b9/src/plugins/mermaid.ts
+
 import { visit } from "unist-util-visit";
 import type { RemarkPlugin } from "@astrojs/markdown-remark";