Metadata-Version: 2.4
Name: mkdocs-allscreenshots-og-screenshot
Version: 0.1.2
Summary: MkDocs plugin for dynamic OpenGraph images via Allscreenshots API
Author: Allscreenshots
License-Expression: MIT
Project-URL: Homepage, https://allscreenshots.com
Project-URL: Documentation, https://docs.allscreenshots.com
Project-URL: Repository, https://github.com/allscreenshots/mkdocs-og-image-plugin
Project-URL: Issues, https://github.com/allscreenshots/mkdocs-og-image-plugin/issues
Keywords: mkdocs,mkdocs-plugin,og-image,open-graph,opengraph,screenshot,social-cards
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Plugins
Classifier: Framework :: MkDocs
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
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 :: Documentation
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: mkdocs>=1.0
Dynamic: license-file

# mkdocs-allscreenshots-og-screenshot

MkDocs plugin that automatically generates dynamic OpenGraph images for every page using [Allscreenshots](https://allscreenshots.com).

Each page gets a unique `og:image` meta tag pointing to a live screenshot of that page.

## Installation
```bash
pip install mkdocs-allscreenshots-og-screenshot
```

Or install locally:
```bash
pip install -e .
```

## Usage

Add the plugin to your `mkdocs.yml`:
```yaml
site_url: https://yourdomain.com

plugins:
  - search
  - allscreenshots-og-screenshot
```

This will add the following meta tag to each page:
```html
<meta property="og:image" content="https://og.allscreenshots.com?url=https%3A%2F%2Fyourdomain.com%2Fyour-page%2F" />
```

## Configuration
```yaml
plugins:
  - allscreenshots-og-screenshot:
      screenshot_base_url: https://og.allscreenshots.com  # default
      site_url: https://yourdomain.com  # optional, falls back to site_url in mkdocs.yml
```

| Option | Default | Description |
|--------|---------|-------------|
| `screenshot_base_url` | `https://og.allscreenshots.com` | Base URL for the screenshot API |
| `site_url` | - | Override the site URL (uses `site_url` from mkdocs.yml by default) |

## License

MIT

## Source

This repository was initialized from the published PyPI source distribution
`mkdocs-allscreenshots-og-screenshot` version `0.1.1`. The plugin code is unchanged
in 0.1.2; only packaging metadata (license, authors, URLs, classifiers) was updated.

Source archive SHA-256:
`b38000ae697eab07dcc90bfa1f6f3d8c957cd8075315fbd51e8729aaab328d81`

Package: https://pypi.org/project/mkdocs-allscreenshots-og-screenshot/0.1.1/
