A MkDocs plugin that supports external link preview
Project description
mkdocs-obsidian-support-plugin
Plugin for mkdocs-material provide external link preview.
pip install beautifulsoup4
pip install mkdocs-link-preview-plugin
It requires beautifulsoup4 for crawling the open grapth protocol metadata.
Usage
Activate the plugin in mkdocs.yml
plugins:
- link-preview
extra_css:
- path/to/link-preview.css
Feature
It converts below codeblock syntax to preview-html based on The Open Graph Protocol.
```preview
https://github.com/ndy2/mkdocs-link-preview-plugin
```
rendered as
with default css configuration.
- super simple demo link - https://ndy2.github.io/mkdocs-link-preview-plugin/
Inspired by
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file mkdocs-link-preview-plugin-0.4.1.tar.gz.
File metadata
- Download URL: mkdocs-link-preview-plugin-0.4.1.tar.gz
- Upload date:
- Size: 4.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7b64a73a3443a4c6b924df841c2b54127ceb8de43d6c4d529b4c26577f8e2b20
|
|
| MD5 |
68c4022c69874e2f0da1f07a7bdab483
|
|
| BLAKE2b-256 |
7fb00d86b889bc8c1d6a13fdcb17bdbcce90527b486145684cb5b9647749979f
|