feat(core) enabled remark-gfm enabling tables in markdown (#1062)

* feat(core) enabled remark-gfm enabling tables in markdown * Create sour-mails-mix.md
event-catalog · Dec 19, 2024 · 12bbcaa · 12bbcaa
1 parent a60e94f
commit 12bbcaa
Show file tree

Hide file tree

Showing 8 changed files with 59 additions and 2 deletions.
diff --git a/.changeset/sour-mails-mix.md b/.changeset/sour-mails-mix.md
@@ -0,0 +1,5 @@
+---
+"@eventcatalog/core": patch
+---
+
+feat(core) enabled remark-gfm enabling tables in markdown
diff --git a/eventcatalog/astro.config.mjs b/eventcatalog/astro.config.mjs
@@ -47,7 +47,7 @@ export default defineConfig({
       // https://docs.astro.build/en/guides/integrations-guide/mdx/#optimize
       optimize: config.mdxOptimize || false,
       remarkPlugins: [remarkDirective, remarkDirectives, remarkComment, mermaid],
-      gfm: false,
+      gfm: true,
     }),
     pagefind(),
   ],

diff --git a/eventcatalog/src/components/MDX/NodeGraph/NodeGraph.tsx b/eventcatalog/src/components/MDX/NodeGraph/NodeGraph.tsx
@@ -422,7 +422,7 @@ const NodeGraph = ({
             <div className="flex justify-between" id="visualiser-footer">
               {footerLabel && (
                 <div className="py-2 w-full text-left ">
-                  <span className=" text-sm no-underline py-2 text-gray-300">{footerLabel}</span>
+                  <span className=" text-sm no-underline py-2 text-gray-500">{footerLabel}</span>
                 </div>
               )}
 

diff --git a/examples/default/domains/Orders/services/InventoryService/index.md b/examples/default/domains/Orders/services/InventoryService/index.md
@@ -38,13 +38,25 @@ import Footer from '@catalog/components/footer.astro';
 
 The Inventory Service is a critical component of the system responsible for managing product stock levels, tracking inventory movements, and ensuring product availability. It interacts with other services to maintain accurate inventory records and supports operations such as order fulfillment, restocking, and inventory audits.
 
+
+
 <Tiles >
     <Tile icon="DocumentIcon" href={`/docs/services/${frontmatter.id}/${frontmatter.version}/changelog`}  title="View the changelog" description="Want to know the history of this service? View the change logs" />
     <Tile icon="UserGroupIcon" href="/docs/teams/full-stack" title="Contact the team" description="Any questions? Feel free to contact the owners" />
     <Tile icon="BoltIcon" href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Sends ${frontmatter.sends.length} messages`} description="This service sends messages to downstream consumers" />
     <Tile icon="BoltIcon"  href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Receives ${frontmatter.receives.length} messages`} description="This service receives messages from other services" />
 </Tiles>
 
+## Core features
+
+| Feature | Description |
+|---------|-------------|
+| Real-time Stock Tracking | Monitors inventory levels across all warehouses in real-time |
+| Automated Reordering | Triggers purchase orders when stock levels fall below defined thresholds |
+| Multi-warehouse Support | Manages inventory across multiple warehouse locations |
+| Batch Processing | Handles bulk inventory updates and adjustments efficiently |
+
+
 
 ## Architecture diagram
 

diff --git a/examples/default/domains/Orders/services/NotificationService/index.md b/examples/default/domains/Orders/services/NotificationService/index.md
@@ -38,6 +38,20 @@ The Notification Service is responsible for managing and delivering notification
     <Tile icon="BoltIcon"  href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Receives ${frontmatter.receives.length} messages`} description="This service receives messages from other services" />
 </Tiles>
 
+### Core features
+
+| Feature | Description |
+|---------|-------------|
+| Multi-Channel Delivery | Supports notifications via email, SMS, push notifications, and in-app messages |
+| Template Management | Customizable notification templates with dynamic content placeholders |
+| Delivery Status Tracking | Real-time tracking and monitoring of notification delivery status |
+| Rate Limiting | Prevents notification flooding through configurable rate limits |
+| Priority Queue | Handles urgent notifications with priority delivery mechanisms |
+| Batch Processing | Efficiently processes and sends bulk notifications |
+| Retry Mechanism | Automatic retry logic for failed notification deliveries |
+| Event-Driven Notifications | Triggers notifications based on system events and user actions |
+
+
 
 ## Architecture diagram
 

diff --git a/examples/default/domains/Orders/services/OrdersService/index.md b/examples/default/domains/Orders/services/OrdersService/index.md
@@ -39,6 +39,15 @@ The Orders Service is responsible for managing customer orders within the system
     <Tile icon="BoltIcon"  href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Receives ${frontmatter.receives.length} messages`} description="This service receives messages from other services" />
 </Tiles>
 
+### Core features
+
+| Feature | Description |
+|---------|-------------|
+| Order Management | Handles order creation, updates, and status tracking |
+| Inventory Integration | Validates and processes inventory for incoming orders |
+| Payment Processing | Integrates with payment gateways to handle payment transactions |
+| Notification Integration | Sends notifications to users and other services |
+
 ## Architecture diagram 
 
 <NodeGraph />

diff --git a/examples/default/domains/Payment/services/PaymentService/index.md b/examples/default/domains/Payment/services/PaymentService/index.md
@@ -23,6 +23,14 @@ repository:
 
 The Payment Service is a crucial component of our system that handles all payment-related operations. It processes payments, manages transactions, and communicates with other services through events. Using an event-driven architecture, it ensures that all actions are asynchronous, decoupled, and scalable.
 
+### Core features
+
+| Feature | Description |
+|---------|-------------|
+| Payment Processing | Processes payments and manages transactions |
+| Event-Driven Architecture | Ensures asynchronous, decoupled, and scalable operations |
+| Integration with Payment Gateways | Interfaces with external payment providers |
+
 <NodeGraph />
 
 ## Infrastructure

diff --git a/examples/default/domains/Subscriptions/services/SubscriptionService/index.md b/examples/default/domains/Subscriptions/services/SubscriptionService/index.md
@@ -37,6 +37,15 @@ The subscription Service is responsible for handling customer subscriptions in o
     <Tile icon="BoltIcon"  href={`/visualiser/services/${frontmatter.id}/${frontmatter.version}`} title={`Receives ${frontmatter.receives.length} messages`} description="This service receives messages from other services" />
 </Tiles>
 
+### Core features
+
+| Feature | Description |
+|---------|-------------|
+| Subscription Management | Handles subscription creation, updates, and status tracking |
+| Payment Processing | Integrates with payment gateways to handle payment transactions |
+| Notification Integration | Sends notifications to users and other services |
+| Multi-Channel Fulfillment | Supports multiple fulfillment channels (e.g., shipping, in-store pickup) |
+
 ## Architecture diagram 
 
 <NodeGraph />