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)富文本编辑器,面向网页,注重兼容性与可扩展性。
它是独立应用,还是需要嵌入的库?它是一个可嵌入网页的 JavaScript/TypeScript 库:在 div 上创建一个 Quill 实例,即可把它变成富文本编辑器。
我该如何把它添加到项目中?可以把它安装为 npm 包,或通过 CDN 引入,然后创建一个目标 div,并实例化 `new Quill(selector, options)`。
使用它需要构建工具或框架吗?不需要特定框架;它只需要一个指向 div 的普通 CSS 选择器即可工作。该仓库本身是由 npm 管理的多包仓库(monorepo)(npm >=8.2.3)。
去哪里找完整文档和在线演示环境?Quill 官网提供文档、指南,以及在线演示/试玩环境,方便在集成前先体验编辑器。
Quill 与其他富文本编辑器有什么不同?它的核心目标就是兼容性和可扩展性,因此可以被定制和扩展,而不是一个固定、封闭的编辑器。
Creator
slab
Size
18 MB
Stars
47.4K
Age
14y
Commits · 90 Days