Giter VIP home page Giter VIP logo

skunkworks's Introduction

Summernote

Super simple WYSIWYG Editor.

Build Status npm version Coverage Status

Summernote

Summernote is a JavaScript library that helps you create WYSIWYG editors online.

Home page: https://summernote.org

Why Summernote?

Summernote has a few special features:

  • Paste images from clipboard
  • Saves images directly in the content of the field using base64 encoding, so you don't need to implement image handling at all
  • Simple UI
  • Interactive WYSIWYG editing
  • Handy integration with server
  • Supports Bootstrap 3, 4 and 5 integrations
  • Lots of plugins and connectors provided together

Installation and dependencies

Summernote is built on jQuery.

1. Include JS/CSS

Include the following code in the <head> tag of your HTML:

<!-- include libraries(jQuery, bootstrap) -->
<script type="text/javascript" src="//code.jquery.com/jquery-3.6.0.min.js"></script>
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" />
<script type="text/javascript" src="cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js"></script>

<!-- include summernote css/js-->
<link href="summernote-bs5.css" rel="stylesheet">
<script src="summernote-bs5.js"></script>

2. Target a element

Then place a div tag somewhere in the body tag. This element will be replaced with the summernote editor.

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

3. Summernote it!

Finally, run this script after the DOM is ready:

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

For more examples, please visit to homepage.

API

code - get the HTML source code underlying the text in the editor:

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

For more detail about API, please refer to document.

Warning - code injection

The code view allows the user to enter script contents. Make sure to filter/sanitize the HTML on the server. Otherwise, an attacker can inject arbitrary JavaScript code into clients.

For contributing

https://github.com/summernote/summernote/blob/develop/.github/CONTRIBUTING.md

Contacts

Testing powered by


BrowserStack Open-Source Program

License

Summernote may be freely distributed under the MIT license.

skunkworks's People

Contributors

abuabdul avatar anpaul0615 avatar blood72 avatar caseyjhol avatar dandv avatar devlato avatar drewcovi avatar e2goon avatar easylogic avatar extremefe avatar feryardiant avatar gorash avatar hackerlose avatar hackerwins avatar hendrismit avatar jacobbroberg avatar jokamax avatar kankje avatar littlebigbot avatar lqez avatar lucasarruda avatar mstred avatar n1k1ch avatar outsideris avatar reinaldocoelho avatar roseline124 avatar shaunsantacruz avatar soomtong avatar splagemann avatar vphantom avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

skunkworks's Issues

I can't found index.template file

Before submitting an issue, please make sure to search for already open issues, and add to that. This way we can track issues more easily. Thank you, and Thanks for using Summernote.

Please answer the below questions, this will help us to more easily resolve whatever issues you are having, and direct issue to the suitable people to with your issue or to give you correct answers.

Description of your Issue or Request:

When I run yarn dev, I can't found index.template file.

  Module not found: Error: Can't resolve '/Users/user/github/skunkworks/examples/index.template' in '/Users/user/github/skunkworks'

steps to reproduce (Add more if necessary):

What is your Operating System, Browser and Version and Summernote Version you are using:

This can help find and resolve any issues.

  1. Operating System:

  2. Browser and Version:

  3. Summernote Version (including which BS3, BS4, Lite or All):

screenshot of issue

Keyboard shortcuts not working

Keyboard shortcuts not working anymore. When I implemented this into our application, all keyboard shortcuts were working. However, recently (not sure when) all have stopped working. Since we have not updated any of our dependencies since then my best guess is that a new version of the browser has broken this.

I thought I would open this issue so we can both figure out the problem.

Codepen: https://codepen.io/olyop/pen/KKBewvG. I have just pasted the current summernote build javascript and css into the codepen just like in our environment. The fonts aren't working but shouldn't cause a problem.

Summernote Skunkworks version: Compiled Date: 2023-01-27T00:53Z
jQuery version: v3.6.3
Bootstrap Version: v4.4.1
Chrome: 109.0.5414.120
Edge: 109.0.1518.70
OS: Windows 11 & Fedora Linux 37

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.