Skip to main content

An MkDocs plugin that lets you edit code fences in JSFiddle.

Project description

MkDocs JSFiddle Plugin

A plugin for MkDocs that lets you augment your code fences with an "edit in JSFiddle" button.

Installation

This package can be installed via pip.

pip install mkjsfiddle

Then, add jsfiddle to the plugins section of your mkdocs.yml file.

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.

```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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkjsfiddle, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size mkjsfiddle-0.1.1-py3-none-any.whl (5.3 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size mkjsfiddle-0.1.1.tar.gz (4.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page