gitbook-plugin-code-editor
Plugin for Gitbook that displays and runs code from external file. Code is displayed in an Ace editor
Last updated 4 years ago by csorenson .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install gitbook-plugin-code-editor 
SYNC missed versions from official npm registry.

GitBook Plugin to display and run included files.

View/Edit Code in ACE Editor

Editor View

Run code in Page

Run

1. You can use install it via NPM and save it to package.json:

$ npm install gitbook-plugin-code-editor --save

2. Add the plugin to book.json config

{
    "plugins": [ "code-editor"]
}

3. Include codeeditor blocks in your markdown files.

{% codeeditor src='../HTML/4Elements/forms/select.html' %}
{% endcodeeditor %}
{% codeeditor   src='../HTML/4Elements/forms/input.html',
                language='javascript', readOnly='true', theme='github' %}
{% endcodeeditor %}
{% codeeditor src='../HTML/4Elements/forms/meter.html' %}
{% endcodeeditor %}

General Attributes

  • src required - The relative path to the file that will be displayed in the editor and run in page.
  • singleTab optional - Can be set to false, html, result. If html or result, only that tab will be shown.
    • default: false

Editor Attributes

We are using an Ace editor for the editor. We currently support the following attributes.

  • language optional - Sets the programming language mode to be used in the syntax highlighter. The full list of supported languages can be found in the Ace Editor Repository.
    • default: html
  • theme optional - Sets the Ace Editor Theme. The full list of supported themes can be found in the Ace Editor Repository.
    • default: chrome
  • readOnly optional - If set to true, the editor will not be editable.
    • default: false
  • maxLines optional - Sets the maximum number of lines that will be visible in the editor.
    • default: 25

Executed Code Attributes

The executed code displays in an iframe in order to preserve any items in the <head> that may be necessary for the example.

  • height optional - Sets the height of the iframe
    • default: 300

License

MIT License

© 2016 ZingChart, Inc.

Current Tags

  • 1.2.1                                ...           latest (4 years ago)

7 Versions

  • 1.2.1                                ...           4 years ago
  • 1.2.0                                ...           4 years ago
  • 1.1.0                                ...           4 years ago
  • 1.0.4                                ...           4 years ago
  • 1.0.3                                ...           4 years ago
  • 1.0.1                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 3
Dependencies (2)
Dev Dependencies (0)
None
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |