Deployment

When building your documentation, the Starlight Obsidian plugin will generate pages from your Obsidian vault.

Deploying your vault pages

When deploying your Starlight project, the target platform may not have access to the Obsidian vault or it would be impractical to include the vault in the deployment. In such cases, you can use the skipGeneration configuration option to disable the generation of vault pages on specific platforms.

When using this option, you will need to build and commit the generated vault pages before deploying your site.

astro.config.mjs

import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import starlightObsidian from 'starlight-obsidian'

export default defineConfig({
  integrations: [
    starlight({
      plugins: [
        starlightObsidian({
          // Disable generating vault pages when deploying on Vercel.
          skipGeneration: !!process.env['VERCEL'],
        }),
      ],
      title: 'My Docs',
    }),
  ],
})