Metadata-Version: 2.1
Name: mkjsfiddle
Version: 0.1.0
Summary: An MkDocs plugin that lets you edit code fences in JSFiddle.
Home-page: https://github.com/stadiamaps/mkjsfiddle
Author: Stadia Maps
Author-email: info@stadiamaps.com
License: MIT
Description: # MkDocs JSFiddle Plugin
        
        A plugin for [MkDocs](https://www.mkdocs.org/) that lets you
        augment your code fences with an "edit in JSFiddle" button.
        
        ## Installation
        
        This package can be installed via pip.
        
        ```
        pip install mkdocs-foo-plugin
        ```
        
        Then, add `mkjsfiddle` to the `plugins` section of your `mkdocs.yml`
        file.
        
        ```yaml
        plugins:
          - jsfiddle
        ```
        
        ## Usage
        
        Code fences will be left alone by default, as many code blocks may not
        form a coherent block for a user to edit. To opt in for a given code fence,
        add `jsfiddle-` to your fence language declaration, like so.
        
        ~~~markdown
        ```jsfiddle-html
        <!DOCTYPE html>
        <!-- Some content here -->
        ```
        ~~~
        
        The `html` above will be preserved for syntax highlighting, and the
        `jsfiddle-` will be dropped. Other languages are theoretically
        supported, but will have no impact besides code highlighting.
        
        The default behavior is for a simple HTML parser to extract the inline JS
        and CSS elements and put their contents in the appropriate JSFiddle panels.
        More specifically, if you have a `script` tag with the attribute `type=text/javascript`
        AND not having the `src` attribute, or if you have a `style` tag with the attribute
        `type=text/css`, it will be extracted to the appropriate panel. If you have multiple
        of these, they will all be extracted and concatenated with some newlines thrown in as
        breaks.
        
        If you would prefer to opt out of this behavior and just dump everything as-is into
        the HTML box, you can add `-htmlonly` to the language string (for a full string that
        looks something like `jsfiddle-html-htmlonly`).
        
        ## Known limitations
        
        We attempt to keep formatting as-is, but make no guarantees in the default mode. The
        `-htmlonly` option however should preserve formatting (if it does not, please submit
        a bug report). This has been developed and tested with the `readthedocs` style, and
        has not been tested extensively with additional styles. Pull requests to improve styling
        are welcome.
        
Keywords: mkdocs jsfiddle plugin
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
Provides-Extra: test
