https://github.com/adityatelange/astro-obsidian-starlight-notes-template

Template I use to publish Obsidian Notes
https://github.com/adityatelange/astro-obsidian-starlight-notes-template

astro notes obsidian starlight template

Last synced: 24 days ago
JSON representation

Template I use to publish Obsidian Notes

• Host: GitHub
• URL: https://github.com/adityatelange/astro-obsidian-starlight-notes-template
• Owner: adityatelange
• License: mit
• Created: 2025-02-01T09:30:25.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2025-02-01T09:54:57.000Z (3 months ago)
• Last Synced: 2025-04-12T09:46:57.451Z (26 days ago)
• Topics: astro, notes, obsidian, starlight, template
• Language: JavaScript
• Homepage: https://adityatelange.github.io/astro-obsidian-starlight-notes-template/
• Size: 178 KB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Astro-Obsidian-Starlight-Notes template

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

![image](https://github.com/user-attachments/assets/72a4456e-165d-45eb-9028-07c78e1d6bab)

![image](https://github.com/user-attachments/assets/56f98fae-7162-4ca5-b041-883110ec7323)

## 🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

```

.

├── public/

├── src/

│   ├── assets/

│   ├── content/

│   │   ├── docs/

│   └── content.config.ts

├── astro.config.mjs

├── package.json

└── tsconfig.json

```

Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.

Images can be added to `src/assets/` and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the `public/` directory.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command                   | Action                                           |

| :------------------------ | :----------------------------------------------- |

| `bun install`             | Installs dependencies                            |

| `bun run dev`             | Starts local dev server at `localhost:4321`      |

| `bun run build`           | Build your production site to `./dist/`          |

| `bun run preview`         | Preview your build locally, before deploying     |

| `bun run astro ...`       | Run CLI commands like `astro add`, `astro check` |

| `bun run astro -- --help` | Get help using the Astro CLI                     |

## Thanks to following projects

- https://github.com/HiDeoo/starlight-blog 

- https://github.com/HiDeoo/starlight-obsidian

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

## 👀 Want to learn more?

Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).