Skip to content

ndy2/mkdocs-link-preview-plugin

Repository files navigation

mkdocs-obsidian-support-plugin


Plugin for mkdocs provide external link preview.

PyPI

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

image

with default css configuration.

Inspired by

Releases

No releases published

Packages

No packages published