---

---

GET STARTED  ·  WEBSITE  ·  CONFIGURATION  ·  CHANGELOG

---

A Starlight theme inspired by the style of Obsidian Publish websites.

---

📑 Table of Contents

• 📑 Table of Contents
• 🧰 Set-up
• 💬 Discussion and Feedback
• 💎 Acknowledgements
• 🤝 Contributors
• ❤️ Support

---

🧰 Set-up

You can install this package from npm from your favourite package manager:

npm install starlight-theme-obsidian

If you are using Starlight, you can just add the following to your astro.config.mjs:

// astro.config.mjs
import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import starlightThemeObsidian from 'starlight-theme-obsidian'

export default defineConfig({
    integrations: [
        starlight({ 
            plugins: [starlightThemeObsidian({ ... })],
            title: 'My Docs',
        }),
    ],
})

For more information, check out the Getting Started guide.

💬 Discussion and Feedback

Any feedback would very much be appreciated. Please use the GitHub issue tracker to report bugs, request features, or suggest improvements, or message me over on Discord (@fevol).

---

💎 Acknowledgements

This theme is heavily based on the Starlight Rapide Theme by HiDeoo, licensed under MIT. All credits for page examples, project structure and certain styles go to them.

Where applicable, attribution has been added to each relevant piece of code (or codefile).

The moon icon used for the site favicon is adapted from SVG Repo, which has a CC0 license.

This README makes use of shields.io for adding badges to display some cursory information about the project.

🤝 Contributors

HiDeoo - For creating the original Starlight Rapide Theme, which this theme is based on.
mProjectsCode - For providing much-needed feedback on the project.

---

❤️ Support

If you like this project, please consider giving it a star on GitHub, contributing some code, or sponsoring me via GitHub Sponsors.