editor-ninja

the missing front-end markdown editor for Airpub and everyone else

Usage no npm install needed!

<script type="module">
  import editorNinja from 'https://cdn.skypack.dev/editor-ninja';
</script>

README

editor-ninja

npm

a hackable Markdown editor based on CodeMirror. inspired by lepture's editor.

screenshot

Features

  • Supports Markdown and GFM
  • Flexible and expandable
  • Supports Angular.js directive
  • Supports real time highlight in Markdown code block
  • Built-in image upload addon
  • Easy-to-use API

Installation

$ bower install ninja --save

Or use NPM instead of bower:

$ npm install editor-ninja --save

Then, link these files into your HTML:

<link rel="stylesheet" href="dist/ninja.min.css">
<script src="dist/ninja.min.js"></script>

Basic Example

HTML Part:

<textarea id="editor">
  Texts...
</textarea>

Javascript Part

basic useage:

new EditorNinja(document.getElementById('editor'));

advanced useage:

var editor = new EditorNinja();

editor
  .tool('custom', bindClick)
  .tool(
    'inject-custom-html', 
    '<span class="style-class">' +
      'customHtml' + 
      '<i class="fa fa-home"></i>' +
    '</span>', 
    bindClick
  )
  .render();

function bindClick(editor) {
  console.log('just clicked!');
  // inject texts
  editor.inject('you have been hacked!');
}

Angular.js Example

HTML Part:

<body ng-app="app">
  <div ng-controller="article">
    <editor-ninja ng-model="content"></editor-ninja>
  </div>
</body>

Angular.js Part:

angular
  .module('app', ['EditorNinja', 'EditorNinja.upload'])
  .config(['EditorNinjaUploadProvider', function(upload) {
    // config upload buckct
    upload.config('upyun', {
      bucket: 'xxx',
      form_api_secret: 'xxxxxxx'
    });
  }])
  .controller('article', ['$scope', function($scope){
    $scope.content = 'texts';
  }]);

Contributing

  • Fork this repo
  • Clone your repo
  • Install dependencies
  • Checkout a feature branch
  • Feel free to add your features
  • Make sure your features are fully tested
  • Open a pull request, and enjoy <3

MIT license

Copyright (c) 2014 Hsiaoming Yang, Guo Yu <o.u.turing@gmail.com>

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.


docor built upon love by docor v0.1.3