@eventcatalog/core 3.36.4 → 3.36.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/analytics/analytics.cjs +1 -1
- package/dist/analytics/analytics.js +2 -2
- package/dist/analytics/log-build.cjs +1 -1
- package/dist/analytics/log-build.js +3 -3
- package/dist/{chunk-XTJ636IF.js → chunk-2WL2AHTJ.js} +1 -1
- package/dist/{chunk-6JY6QF7D.js → chunk-CZV4WMQ2.js} +1 -1
- package/dist/{chunk-7WJEUZFM.js → chunk-J3ZV5QI5.js} +3 -3
- package/dist/{chunk-NV7DNZ3X.js → chunk-TGSOUKM7.js} +1 -1
- package/dist/{chunk-HF27CRFY.js → chunk-VDTDZ4XR.js} +1 -1
- package/dist/constants.cjs +1 -1
- package/dist/constants.js +1 -1
- package/dist/docs/development/bring-your-own-documentation/custom-pages/03-components.md +7 -0
- package/dist/docs/development/components/components/08-flow.md +14 -5
- package/dist/docs/development/components/components/12-nodegraph.md +7 -4
- package/dist/eventcatalog.cjs +1 -1
- package/dist/eventcatalog.js +10 -10
- package/dist/generate.cjs +1 -1
- package/dist/generate.js +3 -3
- package/dist/utils/cli-logger.cjs +1 -1
- package/dist/utils/cli-logger.js +2 -2
- package/eventcatalog/src/enterprise/custom-documentation/pages/docs/custom/index.astro +2 -2
- package/eventcatalog/src/enterprise/custom-documentation/pages/docs/custom/root-index.astro +32 -28
- package/eventcatalog/src/layouts/VerticalSideBarLayout.astro +1 -1
- package/package.json +3 -3
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import {
|
|
2
2
|
log_build_default
|
|
3
|
-
} from "../chunk-
|
|
3
|
+
} from "../chunk-J3ZV5QI5.js";
|
|
4
|
+
import "../chunk-VDTDZ4XR.js";
|
|
4
5
|
import "../chunk-4UVFXLPI.js";
|
|
5
|
-
import "../chunk-
|
|
6
|
-
import "../chunk-NV7DNZ3X.js";
|
|
6
|
+
import "../chunk-TGSOUKM7.js";
|
|
7
7
|
import "../chunk-5T63CXKU.js";
|
|
8
8
|
export {
|
|
9
9
|
log_build_default as default
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
+
import {
|
|
2
|
+
raiseEvent
|
|
3
|
+
} from "./chunk-VDTDZ4XR.js";
|
|
1
4
|
import {
|
|
2
5
|
countResources,
|
|
3
6
|
serializeCounts
|
|
4
7
|
} from "./chunk-4UVFXLPI.js";
|
|
5
|
-
import {
|
|
6
|
-
raiseEvent
|
|
7
|
-
} from "./chunk-HF27CRFY.js";
|
|
8
8
|
import {
|
|
9
9
|
getEventCatalogConfigFile,
|
|
10
10
|
verifyRequiredFieldsAreInCatalogConfigFile
|
package/dist/constants.cjs
CHANGED
package/dist/constants.js
CHANGED
|
@@ -36,6 +36,10 @@ This is my custom documentation page, here is a NodeGraph:
|
|
|
36
36
|
Rest of my markdown content...
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
+
:::note Required props
|
|
40
|
+
In custom documentation pages, `id`, `version`, and `type` are all required. A `<NodeGraph />` missing any of these props is silently ignored.
|
|
41
|
+
:::
|
|
42
|
+
|
|
39
43
|
#### NodeGraph props
|
|
40
44
|
|
|
41
45
|
| Prop | Type | Required | Description |
|
|
@@ -43,4 +47,7 @@ Rest of my markdown content...
|
|
|
43
47
|
| `id` | string | Yes | The id of the resource (domain, service, or message) |
|
|
44
48
|
| `version` | string | Yes | The version of the resource |
|
|
45
49
|
| `type` | string | Yes | The type of the resource (domain, service, command, event, query) |
|
|
50
|
+
| `search` | boolean | No | Show or hide the search bar. Accepts `true`/`false` or `"true"`/`"false"`. Defaults to `true`. |
|
|
51
|
+
| `legend` | boolean | No | Show or hide the legend. Accepts `true`/`false` or `"true"`/`"false"`. Defaults to `true`. |
|
|
52
|
+
| `mode` | string | No | `"simple"` or `"full"`. Defaults to `"simple"`. |
|
|
46
53
|
|
|
@@ -14,20 +14,29 @@ Embed flows into your pages.
|
|
|
14
14
|
**Example**
|
|
15
15
|
|
|
16
16
|
```jsx /domains/MyDomain/index.mdx
|
|
17
|
-
<Flow id="CancelSubscription" version="latest"
|
|
17
|
+
<Flow id="CancelSubscription" version="latest" legend={false} />
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
### Output
|
|
21
21
|

|
|
22
22
|
|
|
23
23
|
### Props
|
|
24
|
+
|
|
25
|
+
<AddedIn version="3.36.3" />
|
|
26
|
+
|
|
24
27
|
| Name | Type | Default | Description |
|
|
25
28
|
| ----------------------- | --------- | ----------------- | ----------------------------------------------------------------- |
|
|
26
29
|
| `id` (required) | `string` | (empty) | Flow id to render in your page |
|
|
27
|
-
| `version` (optional) | `string` | "latest" | Version of the flow to render. Supports exact version and semver versions (e.g 1.0.x, ^1.3.5, latest)|
|
|
28
|
-
| `
|
|
29
|
-
| `search` (optional) | `boolean` |
|
|
30
|
-
| `
|
|
30
|
+
| `version` (optional) | `string` | `"latest"` | Version of the flow to render. Supports exact version and semver versions (e.g 1.0.x, ^1.3.5, latest)|
|
|
31
|
+
| `legend` (optional) | `boolean` | `true` | Show or hide the diagram key. Accepts `true`/`false` or `"true"`/`"false"`. `includeKey` is still accepted as an alias. |
|
|
32
|
+
| `search` (optional) | `boolean` | `false` | Show or hide the search bar in the flow. Accepts `true`/`false` or `"true"`/`"false"`. |
|
|
33
|
+
| `walkthrough` (optional) | `boolean` | `false` | Show or hide the step walkthrough controls. Accepts `true`/`false` or `"true"`/`"false"`. |
|
|
34
|
+
| `mode` (optional) | `string` ("simple" or "full") | `"simple"` | `simple` renders the flow in a simplified view without descriptions. `full` renders descriptions and other information.|
|
|
35
|
+
|
|
36
|
+
:::tip Multiple embeds per page
|
|
37
|
+
You can embed multiple `<Flow />` components on the same page and each one renders independently.
|
|
38
|
+
:::
|
|
39
|
+
|
|
31
40
|
|
|
32
41
|
## Interactive controls
|
|
33
42
|
|
|
@@ -25,12 +25,15 @@ The `<NodeGraph/>` component is supported in domains, services, and all messages
|
|
|
25
25
|

|
|
26
26
|
|
|
27
27
|
#### Props
|
|
28
|
+
|
|
29
|
+
<AddedIn version="3.36.3" />
|
|
30
|
+
|
|
28
31
|
| Name | Type | Default | Description |
|
|
29
32
|
| ----------------------- | --------- | ----------------- | ----------------------------------------------------------------- |
|
|
30
|
-
| `maxHeight` (optional) | `string` | 30 | Max height to set the nodegraph in your document|
|
|
31
|
-
| `search` (optional) | `boolean` | true | Show or hide the search bar
|
|
32
|
-
| `legend` (optional) | `boolean` | true | Show or hide the legend
|
|
33
|
-
| `mode` (optional) | `string` ("simple" or "full") | "simple" | `simple`
|
|
33
|
+
| `maxHeight` (optional) | `string` | `30` | Max height to set the nodegraph in your document|
|
|
34
|
+
| `search` (optional) | `boolean` | `true` | Show or hide the search bar. Accepts `true`/`false` or `"true"`/`"false"`. |
|
|
35
|
+
| `legend` (optional) | `boolean` | `true` | Show or hide the legend. Accepts `true`/`false` or `"true"`/`"false"`. |
|
|
36
|
+
| `mode` (optional) | `string` ("simple" or "full") | `"simple"` | `simple` renders a simplified view without descriptions. `full` renders descriptions and other information.|
|
|
34
37
|
|
|
35
38
|
|
|
36
39
|
## Interactive controls
|
package/dist/eventcatalog.cjs
CHANGED
|
@@ -114,7 +114,7 @@ var verifyRequiredFieldsAreInCatalogConfigFile = async (projectDirectory) => {
|
|
|
114
114
|
var import_picocolors = __toESM(require("picocolors"), 1);
|
|
115
115
|
|
|
116
116
|
// package.json
|
|
117
|
-
var version = "3.36.
|
|
117
|
+
var version = "3.36.5";
|
|
118
118
|
|
|
119
119
|
// src/constants.ts
|
|
120
120
|
var VERSION = version;
|
package/dist/eventcatalog.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import {
|
|
2
|
-
|
|
3
|
-
} from "./chunk-
|
|
4
|
-
import "./chunk-
|
|
2
|
+
runMigrations
|
|
3
|
+
} from "./chunk-XUAF2H54.js";
|
|
4
|
+
import "./chunk-CA4U2JP7.js";
|
|
5
5
|
import {
|
|
6
6
|
resolve_catalog_dependencies_default
|
|
7
7
|
} from "./chunk-WAJIJEI3.js";
|
|
@@ -12,10 +12,10 @@ import {
|
|
|
12
12
|
watch
|
|
13
13
|
} from "./chunk-K3ZVEX2Y.js";
|
|
14
14
|
import {
|
|
15
|
-
|
|
16
|
-
} from "./chunk-
|
|
17
|
-
import "./chunk-
|
|
18
|
-
import "./chunk-
|
|
15
|
+
log_build_default
|
|
16
|
+
} from "./chunk-J3ZV5QI5.js";
|
|
17
|
+
import "./chunk-VDTDZ4XR.js";
|
|
18
|
+
import "./chunk-4UVFXLPI.js";
|
|
19
19
|
import {
|
|
20
20
|
catalogToAstro
|
|
21
21
|
} from "./chunk-YDXB3BD2.js";
|
|
@@ -28,13 +28,13 @@ import {
|
|
|
28
28
|
} from "./chunk-ULZYHF3V.js";
|
|
29
29
|
import {
|
|
30
30
|
generate
|
|
31
|
-
} from "./chunk-
|
|
31
|
+
} from "./chunk-CZV4WMQ2.js";
|
|
32
32
|
import {
|
|
33
33
|
logger
|
|
34
|
-
} from "./chunk-
|
|
34
|
+
} from "./chunk-2WL2AHTJ.js";
|
|
35
35
|
import {
|
|
36
36
|
VERSION
|
|
37
|
-
} from "./chunk-
|
|
37
|
+
} from "./chunk-TGSOUKM7.js";
|
|
38
38
|
import {
|
|
39
39
|
getEventCatalogConfigFile,
|
|
40
40
|
verifyRequiredFieldsAreInCatalogConfigFile
|
package/dist/generate.cjs
CHANGED
package/dist/generate.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import {
|
|
2
2
|
generate
|
|
3
|
-
} from "./chunk-
|
|
4
|
-
import "./chunk-
|
|
5
|
-
import "./chunk-
|
|
3
|
+
} from "./chunk-CZV4WMQ2.js";
|
|
4
|
+
import "./chunk-2WL2AHTJ.js";
|
|
5
|
+
import "./chunk-TGSOUKM7.js";
|
|
6
6
|
import "./chunk-5T63CXKU.js";
|
|
7
7
|
export {
|
|
8
8
|
generate
|
package/dist/utils/cli-logger.js
CHANGED
|
@@ -182,7 +182,7 @@ const editUrl =
|
|
|
182
182
|
class="group flex flex-col border border-[rgb(var(--ec-page-border))] rounded-lg p-4 hover:border-[rgb(var(--ec-content-text-muted))] hover:bg-[rgb(var(--ec-content-hover))] transition-colors w-full sm:w-1/2"
|
|
183
183
|
>
|
|
184
184
|
<span class="text-sm text-[rgb(var(--ec-page-text-muted))] mb-1">Previous</span>
|
|
185
|
-
<span class="font-medium text-[rgb(var(--ec-page-text))] group-hover:text-
|
|
185
|
+
<span class="font-medium text-[rgb(var(--ec-page-text))] group-hover:text-[rgb(var(--ec-accent))] transition-colors">
|
|
186
186
|
{prev.label}
|
|
187
187
|
</span>
|
|
188
188
|
</a>
|
|
@@ -198,7 +198,7 @@ const editUrl =
|
|
|
198
198
|
class="group flex flex-col items-end text-right border border-[rgb(var(--ec-page-border))] rounded-lg p-4 hover:border-[rgb(var(--ec-content-text-muted))] hover:bg-[rgb(var(--ec-content-hover))] transition-colors w-full sm:w-1/2"
|
|
199
199
|
>
|
|
200
200
|
<span class="text-sm text-[rgb(var(--ec-page-text-muted))] mb-1">Next</span>
|
|
201
|
-
<span class="font-medium text-[rgb(var(--ec-page-text))] group-hover:text-
|
|
201
|
+
<span class="font-medium text-[rgb(var(--ec-page-text))] group-hover:text-[rgb(var(--ec-accent))] transition-colors">
|
|
202
202
|
{next.label}
|
|
203
203
|
</span>
|
|
204
204
|
</a>
|
|
@@ -99,28 +99,28 @@ if (!isCustomDocsEnabled()) {
|
|
|
99
99
|
---
|
|
100
100
|
|
|
101
101
|
<VerticalSideBarLayout title="Custom Documentation" showNestedSideBar={false}>
|
|
102
|
-
<body class="min-h-screen font-inter">
|
|
102
|
+
<body class="min-h-screen font-inter bg-[rgb(var(--ec-page-bg))] text-[rgb(var(--ec-page-text))]">
|
|
103
103
|
<main class="container px-8 lg:px-8 mx-auto py-8 max-w-[80em]">
|
|
104
104
|
<div class="mb-12">
|
|
105
105
|
<div class="flex flex-col md:flex-row md:items-center md:justify-between gap-6">
|
|
106
106
|
<div>
|
|
107
107
|
<div class="flex flex-wrap items-center gap-3 mb-3">
|
|
108
|
-
<h1 class="text-4xl font-semibold text-
|
|
108
|
+
<h1 class="text-4xl font-semibold text-[rgb(var(--ec-page-text))] font-inter">Custom Documentation</h1>
|
|
109
109
|
<div
|
|
110
110
|
class="inline-flex items-center px-3 py-1.5 rounded-full text-xs font-medium bg-[rgb(var(--ec-accent-subtle))] text-[rgb(var(--ec-accent-text))] border border-[rgb(var(--ec-accent)/0.3)] shadow-xs"
|
|
111
111
|
>
|
|
112
112
|
Pro feature
|
|
113
113
|
</div>
|
|
114
114
|
</div>
|
|
115
|
-
<p class="text-base mb-0 text-
|
|
115
|
+
<p class="text-base mb-0 text-[rgb(var(--ec-page-text-muted))] max-w-3xl">
|
|
116
116
|
Add custom documentation to EventCatalog to create a unified source of truth for your team. Document your
|
|
117
117
|
architecture decisions, patterns, and guidelines.
|
|
118
118
|
</p>
|
|
119
119
|
</div>
|
|
120
120
|
<div class="flex space-x-4 shrink-0">
|
|
121
121
|
<a
|
|
122
|
-
href="https://www.eventcatalog.dev/docs/custom-
|
|
123
|
-
class="inline-flex items-center justify-center px-5 py-2 border border-
|
|
122
|
+
href="https://www.eventcatalog.dev/docs/development/bring-your-own-documentation/custom-pages/introduction"
|
|
123
|
+
class="inline-flex items-center justify-center px-5 py-2 border border-[rgb(var(--ec-page-border))] text-sm font-medium rounded-md text-[rgb(var(--ec-page-text))] bg-[rgb(var(--ec-card-bg))] hover:bg-[rgb(var(--ec-content-hover))] transition-colors"
|
|
124
124
|
>
|
|
125
125
|
Read documentation →
|
|
126
126
|
</a>
|
|
@@ -128,7 +128,7 @@ if (!isCustomDocsEnabled()) {
|
|
|
128
128
|
!isCustomDocsEnabled() && (
|
|
129
129
|
<a
|
|
130
130
|
href="https://www.eventcatalog.dev/pro/trial"
|
|
131
|
-
class="inline-flex items-center justify-center px-5 py-2 border border-transparent text-sm font-medium rounded-md text-
|
|
131
|
+
class="inline-flex items-center justify-center px-5 py-2 border border-transparent text-sm font-medium rounded-md text-[rgb(var(--ec-button-text))] bg-gradient-to-r from-[rgb(var(--ec-accent-gradient-from))] to-[rgb(var(--ec-accent-gradient-to))] hover:opacity-90 shadow-xs"
|
|
132
132
|
>
|
|
133
133
|
Start 14-day trial
|
|
134
134
|
</a>
|
|
@@ -138,58 +138,62 @@ if (!isCustomDocsEnabled()) {
|
|
|
138
138
|
</div>
|
|
139
139
|
</div>
|
|
140
140
|
|
|
141
|
-
<h2 class="text-2xl font-semibold mb-2 text-
|
|
142
|
-
<p class="text-
|
|
141
|
+
<h2 class="text-2xl font-semibold mb-2 text-[rgb(var(--ec-page-text))]">Setup Guide</h2>
|
|
142
|
+
<p class="text-[rgb(var(--ec-page-text-muted))] mb-8 max-w-3xl">
|
|
143
143
|
Custom documentation let's you bring any documentation into EventCatalog. This is useful for documenting your architecture
|
|
144
144
|
decisions, patterns, and guidelines. Follow these steps to get started:
|
|
145
145
|
</p>
|
|
146
146
|
|
|
147
147
|
<div class="space-y-10 mb-12">
|
|
148
|
-
<div class="bg-
|
|
148
|
+
<div class="bg-[rgb(var(--ec-card-bg))] p-6 rounded-lg shadow-xs border border-[rgb(var(--ec-page-border))]">
|
|
149
149
|
<div class="flex items-start gap-4">
|
|
150
150
|
<div
|
|
151
|
-
class="inline-flex items-center justify-center w-8 h-8 rounded-full bg-
|
|
151
|
+
class="inline-flex items-center justify-center w-8 h-8 rounded-full bg-[rgb(var(--ec-accent-subtle))] text-[rgb(var(--ec-accent))] text-lg font-medium shrink-0 mt-1"
|
|
152
152
|
>
|
|
153
153
|
1
|
|
154
154
|
</div>
|
|
155
155
|
<div class="w-full">
|
|
156
|
-
<h3 class="text-xl font-semibold text-
|
|
157
|
-
<p class="text-
|
|
156
|
+
<h3 class="text-xl font-semibold text-[rgb(var(--ec-page-text))] mb-3">Create the content structure</h3>
|
|
157
|
+
<p class="text-[rgb(var(--ec-page-text-muted))] mb-4">
|
|
158
|
+
Create a folder structure in your directory to organize your documentation.
|
|
159
|
+
</p>
|
|
158
160
|
<Code code={folderStructureExample} lang="bash" frame="terminal" />
|
|
159
161
|
</div>
|
|
160
162
|
</div>
|
|
161
163
|
</div>
|
|
162
164
|
|
|
163
|
-
<div class="bg-
|
|
165
|
+
<div class="bg-[rgb(var(--ec-card-bg))] p-6 rounded-lg shadow-xs border border-[rgb(var(--ec-page-border))]">
|
|
164
166
|
<div class="flex items-start gap-4">
|
|
165
167
|
<div
|
|
166
|
-
class="inline-flex items-center justify-center w-8 h-8 rounded-full bg-
|
|
168
|
+
class="inline-flex items-center justify-center w-8 h-8 rounded-full bg-[rgb(var(--ec-accent-subtle))] text-[rgb(var(--ec-accent))] text-lg font-medium shrink-0 mt-1"
|
|
167
169
|
>
|
|
168
170
|
2
|
|
169
171
|
</div>
|
|
170
172
|
<div class="w-full">
|
|
171
|
-
<h3 class="text-xl font-semibold text-
|
|
172
|
-
<p class="text-
|
|
173
|
+
<h3 class="text-xl font-semibold text-[rgb(var(--ec-page-text))] mb-3">Add MDX files</h3>
|
|
174
|
+
<p class="text-[rgb(var(--ec-page-text-muted))] mb-4">Create MDX files with frontmatter and markdown content.</p>
|
|
173
175
|
<Code code={mdxFileExample} lang="mdx" frame="terminal" />
|
|
174
176
|
</div>
|
|
175
177
|
</div>
|
|
176
178
|
</div>
|
|
177
179
|
|
|
178
|
-
<div class="bg-
|
|
180
|
+
<div class="bg-[rgb(var(--ec-card-bg))] p-6 rounded-lg shadow-xs border border-[rgb(var(--ec-page-border))]">
|
|
179
181
|
<div class="flex items-start gap-4">
|
|
180
182
|
<div
|
|
181
|
-
class="inline-flex items-center justify-center w-8 h-8 rounded-full bg-
|
|
183
|
+
class="inline-flex items-center justify-center w-8 h-8 rounded-full bg-[rgb(var(--ec-accent-subtle))] text-[rgb(var(--ec-accent))] text-lg font-medium shrink-0 mt-1"
|
|
182
184
|
>
|
|
183
185
|
3
|
|
184
186
|
</div>
|
|
185
187
|
<div class="w-full">
|
|
186
|
-
<h3 class="text-xl font-semibold text-
|
|
187
|
-
<p class="text-
|
|
188
|
+
<h3 class="text-xl font-semibold text-[rgb(var(--ec-page-text))] mb-3">Update your eventcatalog.config.js file</h3>
|
|
189
|
+
<p class="text-[rgb(var(--ec-page-text-muted))] mb-4">
|
|
188
190
|
Add the customDocs configuration to your eventcatalog.config.js file to define your sidebar structure.
|
|
189
191
|
</p>
|
|
190
192
|
<Code code={configExample} lang="js" frame="terminal" />
|
|
191
|
-
<p class="text-
|
|
192
|
-
|
|
193
|
+
<p class="text-[rgb(var(--ec-page-text-muted))] mt-4">
|
|
194
|
+
This configuration defines the sidebar structure for your custom documentation:
|
|
195
|
+
</p>
|
|
196
|
+
<ul class="list-disc list-inside text-[rgb(var(--ec-page-text-muted))] mt-2 ml-2 space-y-1">
|
|
193
197
|
<li>
|
|
194
198
|
<strong>label</strong>: The display name for each sidebar section
|
|
195
199
|
</li>
|
|
@@ -210,25 +214,25 @@ if (!isCustomDocsEnabled()) {
|
|
|
210
214
|
</div>
|
|
211
215
|
</div>
|
|
212
216
|
|
|
213
|
-
<div class="bg-
|
|
217
|
+
<div class="bg-[rgb(var(--ec-card-bg))] p-6 rounded-lg shadow-xs border border-[rgb(var(--ec-page-border))]">
|
|
214
218
|
<div class="flex items-start gap-4">
|
|
215
219
|
<div
|
|
216
|
-
class="inline-flex items-center justify-center w-8 h-8 rounded-full bg-
|
|
220
|
+
class="inline-flex items-center justify-center w-8 h-8 rounded-full bg-[rgb(var(--ec-accent-subtle))] text-[rgb(var(--ec-accent))] text-lg font-medium shrink-0 mt-1"
|
|
217
221
|
>
|
|
218
222
|
4
|
|
219
223
|
</div>
|
|
220
224
|
<div class="w-full">
|
|
221
|
-
<h3 class="text-xl font-semibold text-
|
|
222
|
-
<p class="text-
|
|
225
|
+
<h3 class="text-xl font-semibold text-[rgb(var(--ec-page-text))] mb-3">Restart EventCatalog</h3>
|
|
226
|
+
<p class="text-[rgb(var(--ec-page-text-muted))] mb-4">
|
|
223
227
|
After configuring your documentation, restart EventCatalog to see your custom documentation.
|
|
224
228
|
</p>
|
|
225
229
|
<div class="mb-4">
|
|
226
230
|
<Code code="npm run dev" lang="bash" frame="terminal" />
|
|
227
231
|
</div>
|
|
228
|
-
<p class="text-
|
|
232
|
+
<p class="text-[rgb(var(--ec-page-text-muted))] mb-4">
|
|
229
233
|
Once restarted, you'll see your custom documentation displayed with the sidebar structure you defined:
|
|
230
234
|
</p>
|
|
231
|
-
<div class="border border-
|
|
235
|
+
<div class="border border-[rgb(var(--ec-page-border))] rounded-lg overflow-hidden">
|
|
232
236
|
<img src="/images/custom-docs-placeholder.png" alt="Example of custom documentation interface" class="w-full" />
|
|
233
237
|
</div>
|
|
234
238
|
</div>
|
|
@@ -150,7 +150,7 @@ const navigationItems = [
|
|
|
150
150
|
href: getDefaultUrl('docs/custom', '/docs/custom'),
|
|
151
151
|
current: currentPath.includes('/docs/custom'),
|
|
152
152
|
isPremium: true,
|
|
153
|
-
visible: isCustomDocsEnabled(),
|
|
153
|
+
visible: isCustomDocsEnabled() && customDocs.length > 0,
|
|
154
154
|
},
|
|
155
155
|
{
|
|
156
156
|
id: '/schemas/explorer',
|
package/package.json
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
},
|
|
8
8
|
"license": "SEE LICENSE IN LICENSE",
|
|
9
9
|
"type": "module",
|
|
10
|
-
"version": "3.36.
|
|
10
|
+
"version": "3.36.5",
|
|
11
11
|
"publishConfig": {
|
|
12
12
|
"access": "public"
|
|
13
13
|
},
|
|
@@ -107,8 +107,8 @@
|
|
|
107
107
|
"uuid": "^10.0.0",
|
|
108
108
|
"zod": "^4.3.6",
|
|
109
109
|
"@eventcatalog/linter": "1.0.23",
|
|
110
|
-
"@eventcatalog/
|
|
111
|
-
"@eventcatalog/
|
|
110
|
+
"@eventcatalog/sdk": "2.21.1",
|
|
111
|
+
"@eventcatalog/visualiser": "^3.20.3"
|
|
112
112
|
},
|
|
113
113
|
"devDependencies": {
|
|
114
114
|
"@astrojs/check": "^0.9.9",
|