Getting Started
A Starlight plugin to publish Obsidian vaults to a Starlight website.
Check out the demo for a preview of the generated pages.
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
-
Starlight Obsidian is a Starlight plugin. Install it using your favorite package manager:
Terminal window npm i starlight-obsidianTerminal window pnpm add starlight-obsidianTerminal window yarn add starlight-obsidianTerminal window ni starlight-obsidian -
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',}),],}) -
Start the development server to preview your vault pages.
The Starlight Obsidian plugin behavior can be tweaked using various configuration options.