https://github.com/ndy2/mkdocs-link-preview-plugin

A MkDocs plugin that supports external link preview
https://github.com/ndy2/mkdocs-link-preview-plugin

mkdocs mkdocs-plugin

Last synced: about 2 months ago
JSON representation

A MkDocs plugin that supports external link preview

• Host: GitHub
• URL: https://github.com/ndy2/mkdocs-link-preview-plugin
• Owner: ndy2
• License: mit
• Created: 2023-02-24T13:58:05.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-24T16:46:58.000Z (over 3 years ago)
• Last Synced: 2025-03-10T21:49:57.386Z (over 1 year ago)
• Topics: mkdocs, mkdocs-plugin
• Language: Python
• Homepage: https://pypi.org/project/mkdocs-link-preview-plugin/
• Size: 631 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# mkdocs-obsidian-support-plugin

---

Plugin for [mkdocs](https://www.mkdocs.org/) provide external link preview.

[![PyPI](https://img.shields.io/pypi/v/mkdocs-link-preview-plugin)](https://pypi.org/project/mkdocs-link-preview-plugin/)

```text

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 

```yaml

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](https://ogp.me/).

````

```preview

https://github.com/ndy2/mkdocs-link-preview-plugin

```

````

rendered as

![image](https://user-images.githubusercontent.com/67302707/221235406-38958e37-2031-4f65-828f-ef41cfa2395a.png)

with default css configuration.

- super simple demo link - https://ndy2.github.io/mkdocs-link-preview-plugin/

### Inspired by

- https://github.com/dhamaniasad/obsidian-rich-links