feat(core): markdown files now support comments (#1029)

* feat(core): markdown files now support comments * Create hungry-snakes-allow.md * feat(core): markdown files now support comments * feat(core): markdown files now support comments
event-catalog · Dec 15, 2024 · fb6c0f2 · fb6c0f2
1 parent 6f4533b
commit fb6c0f2
Show file tree

Hide file tree

Showing 6 changed files with 16,629 additions and 4 deletions.
diff --git a/.changeset/hungry-snakes-allow.md b/.changeset/hungry-snakes-allow.md
@@ -0,0 +1,5 @@
+---
+"@eventcatalog/core": patch
+---
+
+feat(core): markdown files now support comments
diff --git a/eventcatalog/astro.config.mjs b/eventcatalog/astro.config.mjs
@@ -8,6 +8,8 @@ import { join } from 'node:path';
 import remarkDirective from 'remark-directive';
 import { remarkDirectives } from "./src/remark-plugins/directives"
 
+import remarkComment from 'remark-comment'
+
 /** @type {import('bin/eventcatalog.config').Config} */
 import config from './eventcatalog.config';
 import expressiveCode from 'astro-expressive-code';
@@ -44,7 +46,7 @@ export default defineConfig({
     mdx({
       // https://docs.astro.build/en/guides/integrations-guide/mdx/#optimize
       optimize: config.mdxOptimize || false,
-      remarkPlugins: [remarkDirective, remarkDirectives, mermaid],
+      remarkPlugins: [remarkDirective, remarkDirectives, remarkComment, mermaid],
       gfm: false,
     }),
     pagefind(),