gitbook-plugin-codepen

Embed Codepen preview into your Gitbook

DEMO

Install

$npm install --save gitbook-plugin-codepen

Usage

Add the plugin to your book.json like this:

{
    "plugins": ["codepen"]
}

then in your markdown file, you can embed codepen panel like this:

[](codepen://Lingyucoder/AsFJh?height=800&theme=0)

Options

You can set the options of your Gitbook in book.json like this:

"pluginsConfig": {
    "codepen": {
      "height": 400,
      "theme": 14038,
      "description": "somepen",
      "defaultTab": 'html'
    }
}

You can also set options of a specific Codepen panel use URL querystring like ?height=400&theme=14038&description=somepen&defaultTab=html

height

default: 300

theme

default: 0

description

default: ''

defaultTab

default: 'result'

##License

The MIT License (MIT)

Copyright (c) 2015 Lingyu Wang

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.