<div align="center">
  <h1>starlight-obsidian 📔</h1>
  <p>Starlight plugin to publish Obsidian vaults.</p>
</div>

<div align="center">
  <a href="https://github.com/HiDeoo/starlight-obsidian/actions/workflows/integration.yml">
    <img alt="Integration Status" src="https://github.com/HiDeoo/starlight-obsidian/actions/workflows/integration.yml/badge.svg" />
  </a>
  <a href="https://github.com/HiDeoo/starlight-obsidian/blob/main/LICENSE">
    <img alt="License" src="https://badgen.net/github/license/HiDeoo/starlight-obsidian" />
  </a>
  <br />
</div>

## Getting Started

Want to get started immediately? Check out the [getting started guide](https://starlight-obsidian.vercel.app/getting-started/) or check out the [demo](https://starlight-obsidian.vercel.app/demo/hello/) to see the plugin in action.

## Features

A [Starlight](https://starlight.astro.build) plugin to publish [Obsidian](https://obsidian.md) vaults to a Starlight website.

> [!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.

## License

Licensed under the MIT License, Copyright © HiDeoo.

See [LICENSE](https://github.com/HiDeoo/starlight-obsidian/blob/main/LICENSE) for more information.
