Metadata-Version: 2.1
Name: mkdocs-thumbnails
Version: 0.0.4
Summary: An MkDocs plugin.  Generates thumbnails of PDF files and YouTube links.
Home-page: https://github.com/normanlorrain/mkdocs-thumbnails
Author: Norman Lorrain
Author-email: normanlorrain@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/normanlorrain/mkdocs-thumbnails/issues
Description: # mkdocs-thumbnails
        
        [MkDocs](https://www.mkdocs.org/) 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`
        
        Activate the plugin in `mkdocs.yml`.  Include the `attr_list` extension as shown here:
        ```yaml
        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.
        
        More information about plugins in the [MkDocs documentation][mkdocs-plugins].
        
        ## Config
        
        * `style` - This is the CSS style to be set in the thumbnail's image tag
        
        [mkdocs-plugins]: http://www.mkdocs.org/user-guide/plugins/
        
        
        ## Usage
        In the attribute list of a link, add `.pdf` or `.youtube` to turn on the thumbnail for that link.
        
        ```markdown
        # Some example markdown text
        
        * [My PDF file](foo.pdf){.pdf}
        * [A YouTube video link](https://youtu.be/dQw4w9WgXcQ){.youtube}
        
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
