You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
MkDocs plugin to generate thumbnails automatically.
Provides a mechanism to indicate, in Markdown, the desire for PDF files and YouTube links to have a thumbnail image, automatically generated/downloaded.
Setup
Install the plugin using pip:
pip install mkdocs-thumbnails
Edit mkdocs.yml:
Add thumbnails to the list of plugins.
Add markdown.extensions.attr_list(explained here) to the list of markdown extensions:
plugins:
- search
- thumbnails:
# optional styling for the thumbnail:style: margin-top:5px;margin-bottom:5px;margin-right:25px markdown_extensions:
- markdown.extensions.attr_list
Note: The extension If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it explicitly.
style - This is the CSS style to be set in the thumbnail's image tag
Usage
In the attribute list of a link, add .pdf or .youtube to turn on the thumbnail for that link:
[My PDF file](foo.pdf){.pdf}⸱⸱
[A YouTube video link](https://youtu.be/dQw4w9WgXcQ){.youtube}⸱⸱
The markdown conversion generates:
<ahref="foo.pdf" class="pdf" >My PDF file</a><br><ahref="https://youtu.be/dQw4w9WgXcQ" class="youtube" >A YouTube video link</a><br>
...which is converted by the plugin:
<ahref="foo.pdf"><imgsrc="foo.pdf-thumb.png" class="pdf" >My PDF file</a><br><ahref="https://youtu.be/dQw4w9WgXcQ"><imgsrc="dQw4w9WgXcQ-thumb.png" class="youtube" >A YouTube video link</a><br>
Thumbnails are generated automatically. PDF links will have the first page of the PDF in the thumbnail. YouTube thumbnails are downloaded from Youtube via the link: https://img.youtube.com/vi/{id}/default.jpg
In the example above two spaces are added after each line, to force a markdown line break.
About
MkDocs plugin for thumbnail images generated automatically.