Metadata-Version: 2.4
Name: pelican-oembed
Version: 1.0.4
Summary: Pelican plugin: embed oEmbed URLs (YouTube, Vimeo, Twitter, etc.) in Markdown content
Project-URL: Homepage, https://github.com/tclancy/pelican-oembed
Project-URL: Issue Tracker, https://github.com/tclancy/pelican-oembed/issues
Project-URL: Changelog, https://github.com/tclancy/pelican-oembed/blob/main/CHANGELOG.md
Author: Tom Clancy
License: MIT
Keywords: embed,oembed,pelican,plugin,vimeo,youtube
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Framework :: Pelican
Classifier: Framework :: Pelican :: Plugins
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: beautifulsoup4>=4.9
Requires-Dist: micawber>=0.5.4
Requires-Dist: pelican>=4.5
Provides-Extra: markdown
Requires-Dist: markdown>=3.4; extra == 'markdown'
Description-Content-Type: text/markdown

# pelican-oembed

A [Pelican](https://getpelican.com/) plugin that embeds oEmbed URLs (YouTube, Vimeo, Twitter/X, Spotify, etc.) directly in your Markdown content.

Bare URLs on their own line are replaced with embedded HTML using the [Micawber](https://micawber.readthedocs.io/) oEmbed library, before Pelican post-processing runs.

## Installation

```shell
pip install pelican-oembed
```

Then add to your Pelican `pelicanconf.py`:

```python
PLUGINS = ["pelican.plugins.oembed"]
```

## Usage

Place a bare URL on its own line in your Markdown content:

```markdown
Check out this video:

https://www.youtube.com/watch?v=dQw4w9WgXcQ

More text here.
```

The URL will be replaced with the oEmbed HTML (an `<iframe>` for YouTube, etc.).

## Supported Providers

- YouTube (`youtube.com`, `youtu.be`)
- Vimeo (`vimeo.com`)
- Twitter/X (`twitter.com`, `x.com`)
- Instagram (`instagram.com`)
- SoundCloud (`soundcloud.com`)
- Spotify (`open.spotify.com`)
- TikTok (`tiktok.com`)

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

MIT
