quill README

The project's README from github.com/slab/quill. As one markdown file: README.md.

Quill Rich Text Editor

Quill Logo

Documentation • Development • Contributing • Interactive Playground

Build Status Version Downloads


Quill is a modern rich text editor built for compatibility and extensibility. It was created by Jason Chen and Byron Milligan and actively maintained by Slab.

To get started, check out https://quilljs.com/ for documentation, guides, and live demos!

Quickstart

Instantiate a new Quill object with a css selector for the div that should become the editor.

<!-- Include Quill stylesheet -->
<link
  href="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.snow.css"
  rel="stylesheet"
/>

<!-- Create the toolbar container -->
<div id="toolbar">
  <button class="ql-bold">Bold</button>
  <button class="ql-italic">Italic</button>
</div>

<!-- Create the editor container -->
<div id="editor">
  <p>Hello World!</p>
  <p>Some initial <strong>bold</strong> text</p>
  <p><br /></p>
</div>

<!-- Include the Quill library -->
<script src="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.js"></script>

<!-- Initialize Quill editor -->
<script>
  const quill = new Quill("#editor", {
    theme: "snow",
  });
</script>

Take a look at the Quill website for more documentation, guides and live playground!

Download

npm install quill

CDN

<!-- Main Quill library -->
<script src="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.js"></script>

<!-- Theme included stylesheets -->
<link
  href="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.snow.css"
  rel="stylesheet"
/>
<link
  href="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.bubble.css"
  rel="stylesheet"
/>

<!-- Core build with no theme, formatting, non-essential modules -->
<link
  href="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.core.css"
  rel="stylesheet"
/>
<script src="https://cdn.jsdelivr.net/npm/quill@2/dist/quill.core.js"></script>

Community

Get help or stay up to date.

License

BSD 3-clause

quill (slab/quill)

Searching Database…

47.4K ·GitHub
Что это такое?Quill — это современный WYSIWYG-редактор (от «what you see is what you get», то есть «что видишь, то и получаешь») форматированного текста для веба, созданный с упором на совместимость и расширяемость.
Это самостоятельное приложение или библиотека, которую я встраиваю?Это библиотека на JavaScript/TypeScript, которую вы встраиваете в веб-страницу: вы создаёте объект Quill для div, и он превращается в редактор форматированного текста.
Как добавить её в мой проект?Установите её как npm-пакет или подключите через CDN, затем создайте целевой div и вызовите `new Quill(selector, options)`.
Нужны ли мне сборщик или фреймворк, чтобы её использовать?Конкретный фреймворк не требуется: библиотека работает с обычным CSS-селектором, указывающим на div, а сам репозиторий представляет собой монорепозиторий, управляемый через npm (npm >=8.2.3).
Где найти полную документацию и живую песочницу?На сайте Quill есть документация, руководства и живая демо-версия (песочница), где можно попробовать редактор перед интеграцией.
Чем Quill отличается от других редакторов форматированного текста?Он создан специально с упором на совместимость и расширяемость как основные цели, поэтому его можно настраивать и дополнять, а не использовать как фиксированный, закрытый редактор.
Creator
slab
Size
18 MB
Stars
47.4K
Age
14y
Commits · 90 Days