Skip to content

Commit

Permalink
update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
KhudaDad414 committed Nov 22, 2023
1 parent 21da383 commit e660b92
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion docs/pages/application-structure/env-vars-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,12 @@ export default async function () {
glee: { // Glee core configurations
lifecycleDir: './lifecycle',
functionsDir: './functions',
asyncapiFilePath: './asyncapi.json'
asyncapiFilePath: './asyncapi.json',
logs: { // you can change the defualt behaviour of glee which logs everything by default.
incoming: 'channel-only', // only logs the channel not message payload.
outgoing: 'none', //log nothing.
}
},
docs: {
enabled: true, // Enable/Disable documentation generation
folder: 'docs', // Folder where you want the output of your docs to reside.
Expand Down Expand Up @@ -115,6 +120,9 @@ These configurations apply to Glee itself, rather than any specific protocol.
|glee.lifecycleDir|`lifecycle`|Path to the directory that stores your [lifecycle events](./lifecycle-events.md).|
|glee.functionsDir|`functions`| Path to the directory that stores your [functions](./functions.md).|
|glee.asyncapiFilePath|`asyncapi.(yaml \| yml \| json)`| Path to your AsyncAPI file. |
|glee.logs| | glee logs channel and payload by default. you can change this behaviour for incoming and outgoing messages. |
|glee.logs.incoming| "all" | supported values are `channel-only` and `none`. |
|glee.logs.outgoing| "all" | supported values are `channel-only` and `none`. |
#### Generating Documentation
|Field|Description|
|--|--|
Expand Down

0 comments on commit e660b92

Please sign in to comment.