@eventcatalog/create-eventcatalog 2.0.3 → 2.0.4

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/index.js CHANGED
@@ -22652,7 +22652,7 @@ function validateNpmName(name) {
22652
22652
  var package_default = {
22653
22653
  name: "@eventcatalog/create-eventcatalog",
22654
22654
  description: "Create EventCatalog with one command",
22655
- version: "2.0.3",
22655
+ version: "2.0.4",
22656
22656
  bin: {
22657
22657
  "create-catalog": "./dist/index.js"
22658
22658
  },
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@eventcatalog/create-eventcatalog",
3
3
  "description": "Create EventCatalog with one command",
4
- "version": "2.0.3",
4
+ "version": "2.0.4",
5
5
  "bin": {
6
6
  "create-catalog": "./dist/index.js"
7
7
  },
@@ -1,14 +1,20 @@
1
1
  /** @type {import('@eventcatalog/core/bin/eventcatalog.config').Config} */
2
2
  export default {
3
3
  title: 'EventCatalog',
4
- trailingSlash: false,
5
4
  tagline: 'Discover, Explore and Document your Event Driven Architectures',
6
5
  organizationName: 'Your Company',
7
6
  homepageLink: 'https://eventcatalog.dev/',
8
7
  editUrl: 'https://github.com/boyney123/eventcatalog-demo/edit/master',
8
+ // By default set to false, add true to get urls ending in /
9
+ trailingSlash: false,
10
+ // Change to make the base url of the site different, by default https://{website}.com/docs,
11
+ // changing to /company would be https://{website}.com/company/docs,
12
+ base: '/',
13
+ // Customize the logo, add your logo to public/ folder
9
14
  logo: {
10
15
  alt: 'EventCatalog Logo',
11
- src: 'logo.svg'
16
+ src: 'logo.png',
17
+ text: 'EventCatalog'
12
18
  },
13
19
  docs: {
14
20
  sidebar: {
@@ -28,6 +28,8 @@ The `Inventory Adjusted` event is triggered whenever there is a change in the in
28
28
 
29
29
  <NodeGraph />
30
30
 
31
+ <SchemaViewer file="schema.json" title="JSON Schema" maxHeight="500" />
32
+
31
33
  ## Payload example
32
34
 
33
35
  Event example you my see being published.
@@ -0,0 +1,36 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "title": "Employee",
4
+ "type": "object",
5
+ "description": "A record representing an employee",
6
+ "properties": {
7
+ "Name": {
8
+ "type": "string",
9
+ "description": "The name of the employee"
10
+ },
11
+ "Age": {
12
+ "type": "integer",
13
+ "description": "The age of the employee"
14
+ },
15
+ "Department": {
16
+ "type": "string",
17
+ "description": "The department where the employee works"
18
+ },
19
+ "Position": {
20
+ "type": "string",
21
+ "description": "The position or title of the employee within the department"
22
+ },
23
+ "Salary": {
24
+ "type": "number",
25
+ "format": "double",
26
+ "description": "The salary of the employee"
27
+ },
28
+ "JoinDate": {
29
+ "type": "string",
30
+ "format": "date",
31
+ "description": "The date when the employee joined the company"
32
+ }
33
+ },
34
+ "required": ["Name", "Age", "Department", "Position", "Salary", "JoinDate"]
35
+ }
36
+