Skip to content

fix: update configuration.mdx #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Adammatthiesen merged 2 commits into from
Apr 16, 2025
Merged

fix: update configuration.mdx #61

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de358d0
fix: update `configuration.mdx`
jsparkdev Apr 16, 2025
0862182
Merge branch 'main' into config-en
Adammatthiesen Apr 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions src/content/docs/en/start-here/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ import ReadMore from '~/components/ReadMore.astro';

# Available Options

There are two ways to configure the StudioCMS Integration, below are examples of how to configure based on if you choose to use the `astro.config.mjs` or the dedicated `studiocms.config.mjs` file.
There are two ways to configure the StudioCMS integration. Below are examples of how to configure based on if you choose to use the `astro.config.mjs` or the dedicated `studiocms.config.mjs` file.

<ReadMore>
This page shows you how and where to define the StudioCMS Config. For more information on the StudioCMS config options, see the [Reference pages][reference-page].
This page shows you how and where to define the StudioCMS configuration. For more information on the StudioCMS configuration options, see the [reference page][reference-page].
</ReadMore>

## Using the `astro.config.mjs` file:
## Using the `astro.config.mjs` file

```ts twoslash title="astro.config.mjs"
import db from '@astrojs/db';
Expand All @@ -33,17 +33,17 @@ export default defineConfig({
db(),
studioCMS({
dbStartPage: false,
// ...OtherConfigOptions
// other configuration options
}),
],
});
```

## Using the `studiocms.config.mjs` file (recommended):
## Using the `studiocms.config.mjs` file (recommended)

This file will be automatically picked up and will overwrite any options passed in your astro.config, if you choose to use this option, Please ensure to move all StudioCMS Config options into this file instead like below:
This file will be automatically picked up and will overwrite any options passed in your `astro.config.mjs`, if you choose to use this option. Please ensure to move all StudioCMS configuration options into this file instead like below:

### Example File Structure
### Example file structure

<FileTree>

Expand All @@ -58,7 +58,7 @@ This file will be automatically picked up and will overwrite any options passed

</FileTree>

### Example Config
### Example configuration files

```ts twoslash title="astro.config.mjs"
import db from '@astrojs/db';
Expand All @@ -79,9 +79,9 @@ import { defineStudioCMSConfig } from "studiocms/config";

export default defineStudioCMSConfig({
dbStartPage: false,
// ...OtherConfigOptions
// other configuration options
})
```

{/* Links */}
[reference-page]: /en/config-reference/
[reference-page]: /en/config-reference/
Loading