Download the PHP package sven/commonmark-dark-mode-images without Composer
On this page you can find all versions of the php package sven/commonmark-dark-mode-images. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download sven/commonmark-dark-mode-images
More information about sven/commonmark-dark-mode-images
Files in sven/commonmark-dark-mode-images
Package commonmark-dark-mode-images
Short Description Use different images in light- and dark mode in CommonMark-rendered Markdown
License MIT
Informations about the package commonmark-dark-mode-images
CommonMark Dark Mode Images Extension
⚠️ This package is abandoned. Use sven/commonmark-image-media-queries instead ⚠️
This CommonMark extension allows you to determine what images to show in dark- or light mode in Markdown converted using CommonMark.
Installation
Via composer:
Usage
To enable the extension, first make sure the Attributes extension
that ships with CommonMark is enabled. Then, add the extension to the CommonMark environment:
You'll have to apply some classes to your Markdown images to indicate to this extension that they should be converted:
These {.light-image} and {.dark-image} tags are part of the Attributes extension.
They apply classes to the converted <img> elements, which this extension uses to do its magic. The resulting HTML will
look something like this:
And the result in the browser:
Click to reveal
 Or check out [the first blog post I used this on](https://svenluijten.com/posts/enable-intellisense-for-php-extensions-in-phpstorm).Configuration
Fallback or original
This option allows you to select either 'light' or 'dark' as the "original" form of the picture you're embedding.
This determines which picture will be used if the browser doesn't support the <picture> element.
Class on <picture> element
To change the class that is eventually applied to the rendered <picture> element, use the picture_class
configuration option:
Light and dark classes
Use the dark_image_class and light_image_class configuration options to determine what classes to apply to your
Markdown images to indicate which is for dark mode, and which is for light mode.
Note
It is not recommended to use this extension when converting to Markdown on-the-fly on every request. This is best suited for use in a static site generator like Jigsaw.
Contributing
All contributions (pull requests, issues and feature requests) are welcome. Make sure to read through the contributors page for all contributors.
License
sven/commonmark-dark-mode-images is licensed under the MIT License (MIT). Please see the license file
for more information.