Skip to main content

A MkDocs plugin that supports external link preview

Project description

mkdocs-obsidian-support-plugin


Plugin for mkdocs-material 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs-link-preview-plugin-0.2.3.tar.gz (3.8 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page