https://github.com/pierrenel/astro-embed-obsidian-plugin

Use Obsidian Embeds in your Astro markdown blog posts
https://github.com/pierrenel/astro-embed-obsidian-plugin

Last synced: about 1 month ago
JSON representation

Use Obsidian Embeds in your Astro markdown blog posts

• Host: GitHub
• URL: https://github.com/pierrenel/astro-embed-obsidian-plugin
• Owner: pierrenel
• License: mit
• Created: 2024-07-18T14:08:13.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-18T14:15:34.000Z (4 months ago)
• Last Synced: 2024-09-30T03:48:57.308Z (about 2 months ago)
• Language: JavaScript
• Size: 3.91 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Astro Obsidian Embed Plugin

This Astro plugin allows you to easily embed content in your Markdown files using a custom code block syntax. It is designed to work with the [Obsidian Link Embed plugin](https://github.com/Seraphli/obsidian-link-embed), which allows you to embed content in Obsidian markdown files.

## Installation

```bash

npm install astro-obsidian-embed-plugin

```

## Usage

1. Add the plugin to your `astro.config.mjs` file:

```javascript

import { defineConfig } from 'astro/config';

import embedObsidianPlugin from 'astro-obsidian-embed-plugin';

export default defineConfig({

  integrations: [embedObsidianPlugin()],

});

```

2. In your Markdown files, use the following syntax to embed content:

````

  ```embed

  title: "Example Title"

  image: "https://example.com/image.jpg"

  description: "This is an example description."

  url: "https://example.com"

  ```

````

or just edit your markdown in Obsidian and use the [Obsidian Link Embed plugin](https://github.com/Seraphli/obsidian-link-embed) to embed content.

The plugin will transform this into a nicely formatted embed in your rendered page.

## License

MIT License