Getting Started

A Starlight plugin to publish Obsidian vaults to a Starlight website.

Check out the demo for a preview of the generated pages.

Note

You should also always check that the rendered pages are correct and only include the content you want to publish before publishing your website.

Prerequisites

You will need to have a Starlight website set up. If you don’t have one yet, you can follow the “Getting Started” guide in the Starlight docs to create one.

Installation

1. Starlight Obsidian is a Starlight plugin. Install it using your favorite package manager:

   npm

   npm i starlight-obsidian

   pnpm

   pnpm add starlight-obsidian

   yarn

   yarn add starlight-obsidian

   ni

   ni starlight-obsidian

   Note

   If your vault contains diagrams and charts relying on Mermaid, you will also need to install Playwright:

   npm

   npx playwright install --with-deps chromium

   pnpm

   pnpm playwright install --with-deps chromium

   yarn

   yarn playwright install --with-deps chromium

   ni

   nlx playwright install --with-deps chromium

2. Configure the plugin in your Starlight configuration in the astro.config.mjs file.

   The minimal configuration requires a vault option to point to the path of your Obsidian vault.

   astro.config.mjs

   import starlight from '@astrojs/starlight'
   import { defineConfig } from 'astro/config'
   import starlightObsidian, { obsidianSidebarGroup } from 'starlight-obsidian'
   
   export default defineConfig({
     integrations: [
       starlight({
         plugins: [
           // Generate the Obsidian vault pages.
           starlightObsidian({
             vault: '../path/to/obsidian/vault',
           }),
         ],
         sidebar: [
           {
             label: 'Guides',
             items: ['guides/example'],
           },
           // Add the generated sidebar group to the sidebar.
           obsidianSidebarGroup,
         ],
         title: 'My Docs',
       }),
     ],
   })

3. Start the development server to preview your vault pages.

The Starlight Obsidian plugin behavior can be tweaked using various configuration options.