Skip to content

Ignoring Content

By default, all content in your Obsidian vault is published by the Starlight Obsidian plugin. You can ignore content from being published by using one of the following methods.

`publish` property

The Starlight Obsidian plugin respects the publish Obsidian property. By adding and setting the publish property to false in Obsidian, the associated vault file will be ignored by the Starlight Obsidian plugin.

`ignore` configuration option

The Starlight Obsidian plugin ignore configuration option can be used to ignore content from being published. This option accepts a list of glob patterns to ignore when generating the Obsidian vault pages.

The example below shows various ways to ignore content using the ignore configuration option.

export default defineConfig({
  integrations: [
    starlight({
      plugins: [
        starlightObsidian({
          vault: '../path/to/obsidian/vault',
          ignore: [
            // Ignore all files and folders in the `private` folder.
            'private/**/*',
            // Ignore all files containing `secret` in their name.
            '**/*secret*',
          ],
        }),
      ],
    }),
  ],
})