Configuration

The Starlight Blog plugin can be configured inside the astro.config.mjs configuration file of your project:

astro.config.mjs

import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import starlightBlog from 'starlight-blog'

export default defineConfig({
  integrations: [
    starlight({
      plugins: [
        starlightBlog({
          // Configuration options go here.
        }),
      ],
      title: 'My Docs',
    }),
  ],
})

Plugin configuration

The Starlight Blog plugin accepts the following configuration options:

title

Type: string | Record<string, string>
Default: 'Blog'

The title of the blog.

The value can be a string, or for multilingual sites, an object with values for each different locale. When using the object form, the keys must be BCP-47 tags (e.g. en, fr, or zh-CN):

starlightBlog({
  title: {
    en: 'My Blog',
    fr: 'Mon Blog',
  },
})

postCount

Type: number
Default: 5

The number of blog posts to display per page in the blog post list.

recentPostCount

Type: number
Default: 10

The number of recent blog posts to display in the blog sidebar.

showReadingTime

Type: boolean
Default: false

Whether to show an automatically calculated reading time for each blog post. The automatically calculated reading time can be overridden by setting the readingTime frontmatter.

authors

Type: StarlightBlogAuthorsConfig

A list of global authors for all blog posts or regular authors that can be referenced in individual blog posts. Check the “Authors” guide section for more informations.

prevNextLinksOrder

Type: 'chronological' | 'reverse-chronological'
Default: 'reverse-chronological'

The order of the previous and next links in the blog.

By default, next links will point to the next blog post towards the past ('reverse-chronological'). Setting this option to 'chronological' will make next links point to the next blog post towards the future.

prefix

Type: string
Default: 'blog'

The base prefix for all blog routes.

By default, the blog will be available at /blog and blog posts at /blog/example-post. Setting this option to 'news' will make the blog available at /news and blog posts at /news/example-post.

Author configuration

Global authors for all blog posts or regular authors that can be referenced in individual blog posts can be defined using the authors configuration option. When a blog post frontmatter does not define an author, the global authors from the configuration will be used instead. Check the “Authors” guide for more informations.

starlightBlog({
  authors: {
    alice: {
      // Author configuration for the `alice` author goes here.
    },
    bob: {
      // Author configuration for the `bob` author goes here.
    },
  },
})

An author can be configured using the following options:

name (required)

Type: string

The name of the author.

title

Type: string

A title to display below the author’s name.

url

Type: string

A URL to link the author’s name to.

picture

Type: string

A URL or path to an image in the public/ directory to display as the author’s picture. When using remote images, check out the “Authorizing remote images” guide to enable image optimization.