Skip to content

Starlight

It’s a documentation theme built on Astro. It should “just work” with Obsidian notes as long as you use the Starlight Obsidian plugin.

  • Updating Starlight: pnpx @astrojs/upgrade
  • Running in development: pnpm run dev
    • Running with search: pnpm run buildpnpm run preview
  • My own personal publish flow:
    • cd <Starlight repo>
    • pnpm build
    • git diff (just to check quickly that there’s nothing private)
    • git add .
    • git commit -m "Publish notes"
    • git push

If you’re only going to use Starlight for Obsidian and nothing else, then you can follow HiDeoo’s instructions. They essentially just boil down to the following:

  • Go through the official instructions for the Starlight Obsidian plugin.
  • Make sure your package.json file doesn’t have astro check.

Use this tool. Make sure not to have DarkReader enabled since it will live-edit the site.