Skip to content

Commit

Permalink
📝 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Heiner Pöpping committed Apr 11, 2024
1 parent 94139b8 commit d013e99
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 5 deletions.
11 changes: 9 additions & 2 deletions website/docs/configuration/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ slug: development
sidebar_label: Development
---

These options configure your development server started with
`chayns-toolkit dev`.
These options configure your development server started with `chayns-toolkit dev`.

All options aswell as the `toolkit.config.js` file itself are optional.

Expand All @@ -27,6 +26,14 @@ module.exports = {
*/
port: 1337,

/**
* The ports the development servers will run on. Only used when
* output.serverSideRendering is true.
* Defaults to { client: 1234, server: 1235 }.
* @type {{ client: number, server: number }}
*/
ports: { client: 4001, server: 4002 },

/**
* The path to a SSL certificate file for your development server. Not
* specified by default.
Expand Down
24 changes: 21 additions & 3 deletions website/docs/configuration/output.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,31 @@ module.exports = {
* @type {string}
*/
path: "//my-qa-server/example-project",
/**
* Setting apiVersion to 5 enables features required for module federation
* @type undefined | 5
*/
apiVersion: 5,
/**
* The exported entries used for module federation
* @type {{ [key: string]: string }}
*/
exposeModules: {
"./AppWrapper": "./src/AppWrapper",
},
/**
* Enables build which targets server. Only relevant for federated modules which
* should be rendered by a server.
* @type {boolean}
*/
serverSideRendering: false,
},
// ... other options ...
}
```

## Single File Builds

In single-file build mode, the compiler will inline all assets (CSS, images,
etc.) together with all JavaScript into a single bundle. This can be useful when
building smaller fragments of a UI, e.g. some kind of plugin.
In single-file build mode, the compiler will inline all assets (CSS, images, etc.) together with all
JavaScript into a single bundle. This can be useful when building smaller fragments of a UI, e.g.
some kind of plugin.

0 comments on commit d013e99

Please sign in to comment.