search

d0c-s4vage / lookatme.contrib.image_ueberzug

An in-development lookatme extension that uses ueberzug and urwid_ueberzogen to add image rendering support
MIT License
16 stars 4 forks source link

readme

lookatme.contrib.image_ueberzug

This is a lookatme extension that uses ueberzug and urwid-ueberzogen to provide image rendering support. This works on linux with X11 only. This does not work with Wayland.

NOTE: This only works with X11 and does not work with Wayland.

After successfully installing, you should see something like this:

example

Installation

pip install lookatme.contrib.image_ueberzug

Usage

Use images! For now, only local images are supported. Remote image support will be added later.

Enable this plugin by adding it to the metadata in the head of the markdown file.

---
title: <title>
author: <author>
extensions:
  - image_ueberzug
---

Use the text of the image to indicate the height (number of rows) that the image should use when rendered. The example below will render path/to/image.png with a height of 7 rows:

![7](path/to/image.png)