Demo for oembedpy.adapter.mkdocs
Description
This page is demo about working oembedpy.adapters.mkdocs.
Setup
- Install
oEmbedPy. - Add plugin
oembedpyinto your MkDocs configuration.
plugins:
- oembedpy
Usage
Write contents that you want to display embed as code-block fenced oembed.
Contents in code-block must be written as TOML and are one required key and two optional keys.
Keys
-
url: (Required) URL of target content. -
max_width: (Optional) Max width of embed content. -
max_height: (Optional) Max height of embed content.
Demo
URL only
Source:
```oembed
url = 'https://bsky.app/profile/attakei.net/post/3l6uxhgm3sz2t'
```
Output:
sphinx-revealjs v3.0.5 is released! Please see PyPI page.
— (@attakei.net) 2024-10-19T17:00:19.846037+00:00
With size options
Source:
```oembed
url = 'https://www.youtube.com/watch?v=Oyh8nuaLASA'
max_width = 640
max_height = 640
```
Output:
Fallback
This demo works only when set plugin options fallback: true.
plugins:
- oembedpy:
fallback_type: true
Source:
```oembed
url = 'https://www.reddit.com/r/Python/comments/vdopqj/sphinxrevealjs_html_presentation_builder_for/'
```
Output: