https://github.com/fevol/starlight-theme-obsidian

Starlight theme inspired by the style of Obsidian Publish sites
https://github.com/fevol/starlight-theme-obsidian

astro graph obsidian plugin starlight theme

Last synced: 2 months ago
JSON representation

Starlight theme inspired by the style of Obsidian Publish sites

• Host: GitHub
• URL: https://github.com/fevol/starlight-theme-obsidian
• Owner: Fevol
• License: mit
• Created: 2024-09-17T20:36:54.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-10-30T18:42:15.000Z (3 months ago)
• Last Synced: 2024-11-02T09:14:15.144Z (3 months ago)
• Topics: astro, graph, obsidian, plugin, starlight, theme
• Language: CSS
• Homepage: https://fevol.github.io/starlight-theme-obsidian/
• Size: 1.37 MB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


	



---












































---





 GET STARTED

  · 

 WEBSITE

  · 

 CONFIGURATION

  · 

 CHANGELOG





---

A [Starlight](https://starlight.astro.build/) theme inspired by the style of [Obsidian Publish](https://obsidian.md/publish) websites.






	






---



## 📑 Table of Contents

- [📑 Table of Contents](#table-of-contents)

- [🧰 Set-up](#setup)

- [💬 Discussion and Feedback](#discussion-and-feedback)

- [💎 Acknowledgements](#acknowledgements)

- [🤝 Contributors](#contributors)

- [❤️ Support](#support)

---

## 🧰 Set-up

You can install this package from [npm](https://www.npmjs.com/package/starlight-theme-obsidian) from your favourite package manager:

```bash

npm install starlight-theme-obsidian

```

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

```js

// 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](https://fevol.github.io/starlight-theme-obsidian/getting-started/) guide.



## 💬 Discussion and Feedback

Any feedback would _very_ much be appreciated. Please use the [GitHub issue tracker](https://github.com/Fevol/starlight-theme-obsidian/issues/new) 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](https://github.com/HiDeoo/starlight-theme-rapide) 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](https://www.svgrepo.com/svg/120949/moon), which has a CC0 license.

This README makes use of [shields.io](https://shields.io) for adding badges to display some cursory information about the project.



## 🤝 Contributors

[HiDeoo](https://github.com/HiDeoo/) - For creating the original Starlight Rapide Theme, which this theme is based on. 


[mProjectsCode](https://github.com/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](https://github.com/sponsors/Fevol).