Skip to content

Commit dad6bdc

Browse files
committed
docs: remove new frame titles from configuration.mdx
1 parent f961f56 commit dad6bdc

File tree

1 file changed

+5
-20
lines changed

1 file changed

+5
-20
lines changed

docs/src/content/docs/reference/configuration.mdx

+5-20
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Set the description for your website. Used in metadata shared with search engine
4242
Set a logo image to show in the navigation bar alongside or instead of the site title. You can either set a single `src` property or set separate image sources for `light` and `dark`.
4343

4444
```js
45-
// astro.config.mjs
4645
starlight({
4746
logo: {
4847
src: './src/assets/my-logo.svg',
@@ -73,7 +72,6 @@ Configure the table of contents shown on the right of each page. By default, `<h
7372
Enable “Edit this page” links by setting the base URL these should use. The final link will be `editLink.baseUrl` + the current page path. For example, to enable editing pages in the `withastro/starlight` repo on GitHub:
7473

7574
```js
76-
// astro.config.mjs
7775
starlight({
7876
editLink: {
7977
baseUrl: 'https://github.com/withastro/starlight/edit/main/',
@@ -99,7 +97,6 @@ Each item must have a `label` and one of the following properties:
9997
- `autogenerate` — an object specifying a directory of your docs to automatically generate a group of links from.
10098

10199
```js
102-
// astro.config.mjs
103100
starlight({
104101
sidebar: [
105102
// A single link item labelled “Home”.
@@ -132,8 +129,7 @@ Groups of links are expanded by default. You can change this behavior by setting
132129

133130
Autogenerated subgroups respect the `collapsed` property of their parent group by default. Set the `autogenerate.collapsed` property to override this.
134131

135-
```js {6,17}
136-
// astro.config.mjs
132+
```js {5,16}
137133
sidebar: [
138134
// A collapsed group of links.
139135
{
@@ -159,8 +155,7 @@ sidebar: [
159155

160156
If your site is multilingual, each item’s `label` is considered to be in the default locale. You can set a `translations` property to provide labels for your other supported languages:
161157

162-
```js {6,10,15}
163-
// astro.config.mjs
158+
```js {5,9,14}
164159
sidebar: [
165160
// An example sidebar with labels translated to Brazilian Portuguese.
166161
{
@@ -220,7 +215,6 @@ interface BadgeConfig {
220215
Each entry should use the directory where that language’s files are saved as the key.
221216

222217
```js
223-
// astro.config.mjs
224218
import { defineConfig } from 'astro/config';
225219
import starlight from '@astrojs/starlight';
226220

@@ -285,8 +279,7 @@ The writing direction of this language; `"ltr"` for left-to-right (the default)
285279

286280
You can serve the default language without a `/lang/` directory by setting a `root` locale:
287281

288-
```js {4-7}
289-
// astro.config.mjs
282+
```js {3-6}
290283
starlight({
291284
locales: {
292285
root: {
@@ -321,7 +314,6 @@ import SocialLinksType from '../../../components/social-links-type.astro';
321314
Optional details about the social media accounts for this site. Adding any of these will display them as icon links in the site header.
322315

323316
```js
324-
// astro.config.mjs
325317
starlight({
326318
social: {
327319
codeberg: 'https://codeberg.org/knut/examples',
@@ -348,7 +340,6 @@ Provide CSS files to customize the look and feel of your Starlight site.
348340
Supports local CSS files relative to the root of your project, e.g. `'./src/custom.css'`, and CSS you installed as an npm module, e.g. `'@fontsource/roboto'`.
349341

350342
```js
351-
// astro.config.mjs
352343
starlight({
353344
customCss: ['./src/custom-styles.css', '@fontsource/roboto'],
354345
});
@@ -365,8 +356,7 @@ See the [“Code blocks” guide](/guides/authoring-content/#code-blocks) to lea
365356
You can use any of the standard [Expressive Code configuration options](https://github.com/expressive-code/expressive-code/blob/main/packages/astro-expressive-code/README.md#configuration) as well as some Starlight-specific properties, by setting them in Starlight’s `expressiveCode` option.
366357
For example, set Expressive Code’s `styleOverrides` option to override the default CSS. This enables customizations like giving your code blocks rounded corners:
367358

368-
```js ins={3-5}
369-
// astro.config.mjs
359+
```js ins={2-4}
370360
starlight({
371361
expressiveCode: {
372362
styleOverrides: { borderRadius: '0.5rem' },
@@ -376,8 +366,7 @@ starlight({
376366

377367
If you want to disable Expressive Code, set `expressiveCode: false` in your Starlight config:
378368

379-
```js ins={3}
380-
// astro.config.mjs
369+
```js ins={2}
381370
starlight({
382371
expressiveCode: false,
383372
});
@@ -430,7 +419,6 @@ Add custom tags to the `<head>` of your Starlight site.
430419
Can be useful for adding analytics and other third-party scripts and resources.
431420

432421
```js
433-
// astro.config.mjs
434422
starlight({
435423
head: [
436424
// Example: add Fathom analytics script tag.
@@ -482,7 +470,6 @@ A page can override this setting or the link text and/or URL using the [`prev`](
482470
Set the path of the default favicon for your website which should be located in the `public/` directory and be a valid (`.ico`, `.gif`, `.jpg`, `.png`, or `.svg`) icon file.
483471

484472
```js
485-
// astro.config.mjs
486473
starlight({
487474
favicon: '/images/favicon.svg',
488475
}),
@@ -491,7 +478,6 @@ starlight({
491478
If you need to set additional variants or fallback favicons, you can add tags using the [`head` option](#head):
492479

493480
```js
494-
// astro.config.mjs
495481
starlight({
496482
favicon: '/images/favicon.svg'.
497483
head: [
@@ -525,7 +511,6 @@ For example, this page is titled “Configuration Reference” and this site is
525511
Provide the paths to components to override Starlight’s default implementations.
526512

527513
```js
528-
// astro.config.mjs
529514
starlight({
530515
components: {
531516
SocialLinks: './src/components/MySocialLinks.astro',

0 commit comments

Comments
 (0)