GithubHelp home page GithubHelp logo

nvdnkpr / summernote Goto Github PK

View Code? Open in Web Editor NEW

This project forked from summernote/summernote

0.0 2.0 0.0 3.6 MB

Super Simple WYSIWYG Editor on Bootstrap

Home Page: http://hackerwins.github.io/summernote/

summernote's Introduction

Summernote

Super Simple WYSIWYG Editor on Bootstrap(3.0 and 2.x).

Build Status

Summernote

Summernote is a javascript program that helps you to create WYSIWYG Editor on web.

Demo Page: http://hackerwins.github.io/summernote/

Why Summernote?

Summernote has something specials no like others.

Simple UI, Interative WYSIWYG editing, easy integrate Backend server and so much others.

Inspired by

Easy to install

Summernote uses opensouce libraries(jQuery, bootstrap, fontAwesome)

01. include js/css

Include Following code into <head> tag of your HTML:

<!-- include libries(jQuery, bootstrap, fontawesome) -->
<script type="text/javascript" src="//code.jquery.com/jquery-1.9.1.min.js"></script> 
<!-- bootstrap v3 -->
<link rel="stylesheet" href="//netdna.bootstrapcdn.com/bootstrap/3.0.1/css/bootstrap.min.css" />
<script type="text/javascript" src="//netdna.bootstrapcdn.com/bootstrap/3.0.1/js/bootstrap.min.js"></script>
<link rel="stylesheet" href="//netdna.bootstrapcdn.com/font-awesome/4.0.1/css/font-awesome.min.css" />

<!-- include summernote css/js-->
<link rel="stylesheet" href="summernote.css" />
<script type="text/javascript" src="summernote.min.js"></script>

If your summernote download is placed in a different folder, don't forget to change file's paths.

02. target elements

And place div tag to somewhere in the body tag. This element will be placed by the visual representation of the summernote.

<div id="summernote">Hello Summernote</div>

03. summernote

Finally, run script after document ready.

$(document).ready(function() {
  $('#summernote').summernote();
});

API

Get HTML code if you need.

var sHTML = $('#summernote').code();

Destroy summernote.

$('#summernote').destroy();

Dependencies

Supported platform

  • Modern Browser (Safari, Chrome, Firefox, Opera, Internet Explorer 9+)
  • OS (Windows, Mac)

Upcoming Features

  • Air Mode
  • Responsive Toolbar
  • Table: Handles(Sizing, Selection) and Popover
  • support IE8
  • Clipboard
  • Media Object Selection

v0.5 2013-12-31

  • Support both Font-Awesome 3.x and 4.x
  • CodeMirror as Codeview
  • Insert Video (by cdownie)
  • Locale (by hendrismit, tschiela)
  • Bug fixes

Change Log

v0.4 2013-11-01

  • ADDED Support both Bootstrap 3.0 and 2.x
  • ADDED Fullscreen
  • ADDED Code View
  • ADDED Image Upload callback

v0.3 2013-09-01

  • FIXED bugs(image upload, fontsize, tab, recent color, ...)
  • ADDED help dialog(keyboard shortcut)
  • ADDED init options(event callbacks, custom toolbar)
  • ADDED resize bar
  • ADDED support IE8 Beta(some range bugs, can't insert Image)

v0.2, 2013-08-01

  • ADDED undo/redo
  • ADDED image sizing handle and popover
  • ADDED support standalone css
  • ADDED support Multiple Editor
  • REMOVED jQuery.curstyles dependency

v0.1, 2013-07-01

  • ADDED font style: size, color, bold, italic, underline, remove font style
  • ADDED para style: bullet, align, outdent, indent, line height
  • ADDED image: drag & drop, dialog
  • ADDED link: popover and dialog
  • ADDED table: create table with dimension picker

for Hacker

structure of summernote.js

$.extend - Renderer (Markup)
         \ EventHandler - Editor - Range (W3CRange extention)
                                 \ Style (Style Getter and Setter)
                                 \ History (Store on jQuery.data)
                        \ Toolbar
                        \ Popover
                        \ Handle
                        \ Dialog
----------Common Utils----------
Dom, List, Func

build summernote

# grunt-cli is need by grunt; you might have this installed already
npm install -g grunt-cli
npm install
grunt dist

At this point, you should now have a build/ directory populated with everything you need to use summernote.

test summernote

run tests with PhantomJS

grunt test

Coding convention

Contacts

License

summernote may be freely distributed under the MIT license.

summernote's People

Contributors

hackerwins avatar lqez avatar soomtong avatar hendrismit avatar extremefe avatar cdownie avatar daewon avatar inomies avatar tschiela avatar

Watchers

Navid Nikpour avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.