mkdocs-allscreenshots-og-screenshot
MkDocs plugin that automatically generates dynamic OpenGraph images for every page using Allscreenshots.
Each page gets a unique og:image meta tag pointing to a live screenshot of that page.
Installation
pip install mkdocs-allscreenshots-og-screenshot
Or install locally:
pip install -e .
Usage
Add the plugin to your mkdocs.yml:
site_url: https://yourdomain.com
plugins:
- search
- allscreenshots-og-screenshot
This will add the following meta tag to each page:
<meta property="og:image" content="https://og.allscreenshots.com?url=https%3A%2F%2Fyourdomain.com%2Fyour-page%2F" />
Configuration
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/
1 maintainer
Metadata
1 maintainer
Release files for mkdocs-allscreenshots-og-screenshot 0.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| mkdocs_allscreenshots_og_screenshot-0.1.2.tar.gz | 3.8 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_allscreenshots_og_screenshot-0.1.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.3 kB
Release files / mkdocs_allscreenshots_og_screenshot-0.1.2.tar.gz
| Download URL | mkdocs_allscreenshots_og_screenshot-0.1.2.tar.gz |
|---|---|
| Size | 3.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e66c154dd51de14ef78bab911eeac62ac3c64ea0849c8698e2673a47ac9077d0
|
|
BLAKE2b-256 checksum How to use checksums |
3bff33873d4401933e42a1b082fd416e058cea1da43dcb4a18d800c79a9622c5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.5
|
Release files / mkdocs_allscreenshots_og_screenshot-0.1.2-py3-none-any.whl
| Download URL | mkdocs_allscreenshots_og_screenshot-0.1.2-py3-none-any.whl |
|---|---|
| Size | 4.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8351bc47765a03ee3e7125cd09e3bfddf239506f1b974d7cbe836d25f93d0f47
|
|
BLAKE2b-256 checksum How to use checksums |
b1ffcd3fde5a9a16a66cf4c95d28d7d9edd351bfb5a2b575510683f174a0e659
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.5
|
Security for mkdocs-allscreenshots-og-screenshot 0.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
