docs: Add demo for MkDocs integration

Author: attakei

demo/mkdocs/index.md

@@ -0,0 +1,64 @@
+# Demo for oembedpy.adapter.mkdocs
+
+## Description
+
+This page is demo about working `oembedpy.adapters.mkdocs`.
+
+## Setup
+
+1. Install `oEmbedPy`.
+2. Add plugin `oembedpy` into your MkDocs configuration.
+
+```yaml
+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:
+
+````markdown
+```oembed
+url = 'https://bsky.app/profile/attakei.net/post/3l6uxhgm3sz2t'
+```
+````
+
+Output:
+
+```oembed
+url = 'https://bsky.app/profile/attakei.net/post/3l6uxhgm3sz2t'
+```
+
+### With size options
+
+Source:
+
+````markdown
+```oembed
+url = 'https://www.youtube.com/watch?v=Oyh8nuaLASA'
+max_width =  640
+max_height = 640
+```
+````
+
+Output:
+
+```oembed
+url = 'https://www.youtube.com/watch?v=Oyh8nuaLASA'
+max_width =  640
+max_height = 640
+```

docs/.gitignore

@@ -1 +1,2 @@
 api/
+_extra/demo

docs/conf.py

@@ -14,6 +14,7 @@
 
 html_theme = "furo"
 html_static_path = ["_static"]
+html_extra_path = ["_extra"]
 
 # -- Options for Linkcheck output
 linkcheck_ignore = [

mkdocs.yml

@@ -0,0 +1,8 @@
+site_name: 'Demo of oembedpy.adapter.mkdocs'
+# site_url: ''
+
+docs_dir: 'demo/mkdocs'
+site_dir: 'docs/_extra/demo/mkdocs'
+
+plugins:
+  - 'oembedpy'