Skip to content

Commit f89b0e9

Browse files
Add mermaid support (#6327)
1 parent 7a18330 commit f89b0e9

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

docs/snippets/about-eventing.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@
44
-->
55
Knative Eventing is a collection of APIs that enable you to use an [event-driven architecture](https://en.wikipedia.org/wiki/Event-driven_architecture){target=_blank} with your applications. You can use these APIs to create components that route events from event producers (known as sources) to event consumers (known as sinks) that receive events. Sinks can also be configured to respond to HTTP requests by sending a response event.
66

7+
``` mermaid
8+
architecture-beta
9+
group eventing[Eventing]
10+
group sources[Event Sources]
11+
12+
service source(cloud)[Event Source] in sources
13+
service broker(database)[Broker] in eventing
14+
service trigger(server)[Trigger] in eventing
15+
service sink(internet)[Event Target]
16+
17+
source{group}:T --> B:broker
18+
broker:R -- L:trigger
19+
trigger:B --> T:sink
20+
```
21+
722
Knative Eventing is a standalone platform that provides support for various types of workloads, including standard Kubernetes Services and Knative Serving Services.
823

924
Knative Eventing uses standard HTTP POST requests to send and receive events between event producers and sinks. These events conform to the [CloudEvents specifications](https://cloudevents.io/){target=_blank}, which enables creating, parsing, sending, and receiving events in any programming language.

mkdocs.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,11 @@ markdown_extensions:
3030
emoji_generator: !!python/name:material.extensions.emoji.to_svg
3131
- attr_list
3232
- meta
33-
- pymdownx.superfences
33+
- pymdownx.superfences:
34+
custom_fences:
35+
- name: mermaid
36+
class: mermaid
37+
format: !!python/name:pymdownx.superfences.fence_code_format
3438
- pymdownx.tabbed:
3539
alternate_style: true
3640
- pymdownx.details
@@ -54,10 +58,11 @@ plugins:
5458
separator: '[\/\s\-\.]+'
5559
exclude:
5660
glob:
57-
# Exclude files that contain hugo specific shortcodes
58-
# (either the include shortcode or not-converted-yet tabs).
61+
# Exclude files that are built into other parts of the documentation
5962
- snippets/*
6063
- smoketest.md
64+
# This could be used to generate nav from the directory structure.
65+
# It is currently disabled by the `nav` field in `config/nav.yml`.
6166
awesome-pages:
6267
filename: ".index"
6368
collapse_single_pages: true

0 commit comments

Comments
 (0)