Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: slab/quill
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v2.0.0
Choose a base ref
...
head repository: slab/quill
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref
Loading
Showing with 2,131 additions and 1,153 deletions.
  1. 0 { → .github}/CODE_OF_CONDUCT.md
  2. +14 −12 .github/CONTRIBUTING.md
  3. +17 −0 .github/release.yml
  4. +6 −4 .github/workflows/_test.yml
  5. +22 −0 .github/workflows/changelog.yml
  6. +24 −0 .github/workflows/label.yml
  7. +5 −2 .github/workflows/release.yml
  8. +477 −383 CHANGELOG.md
  9. +15 −26 README.md
  10. +342 −51 package-lock.json
  11. +4 −3 package.json
  12. +2 −40 packages/quill/README.md
  13. +5 −4 packages/quill/package.json
  14. +9 −1 packages/quill/playwright.config.ts
  15. +10 −11 packages/quill/src/blots/text.ts
  16. +1 −0 packages/quill/src/core.ts
  17. +2 −1 packages/quill/src/core/editor.ts
  18. +1 −1 packages/quill/src/core/module.ts
  19. +49 −35 packages/quill/src/core/quill.ts
  20. +11 −9 packages/quill/src/modules/clipboard.ts
  21. +7 −0 packages/quill/src/modules/keyboard.ts
  22. +2 −3 packages/quill/src/modules/syntax.ts
  23. +5 −2 packages/quill/src/modules/toolbar.ts
  24. +6 −4 packages/quill/src/modules/uploader.ts
  25. +10 −2 packages/quill/src/quill.ts
  26. +4 −3 packages/quill/src/themes/bubble.ts
  27. +4 −3 packages/quill/src/themes/snow.ts
  28. +8 −0 packages/quill/src/ui/icons.ts
  29. +93 −0 packages/quill/test/e2e/fixtures/Clipboard.ts
  30. +11 −0 packages/quill/test/e2e/fixtures/index.ts
  31. +39 −0 packages/quill/test/e2e/fixtures/utils/Locker.ts
  32. +8 −0 packages/quill/test/e2e/history.spec.ts
  33. +1 −1 packages/quill/test/e2e/list.spec.ts
  34. +54 −16 packages/quill/test/types/quill.test-d.ts
  35. +26 −2 packages/quill/test/unit/core/editor.spec.ts
  36. +58 −2 packages/quill/test/unit/core/quill.spec.ts
  37. +17 −7 packages/quill/test/unit/modules/clipboard.spec.ts
  38. +1 −1 packages/quill/tsconfig.json
  39. +17 −17 packages/website/content/{guides/how-to-customize-quill.mdx → docs/customization.mdx}
  40. 0 packages/website/content/docs/{ → customization}/registries.mdx
  41. 0 packages/website/content/docs/{ → customization}/themes.mdx
  42. 0 packages/website/content/{ → docs}/guides/building-a-custom-module.mdx
  43. 0 packages/website/content/{ → docs}/guides/cloning-medium-with-parchment.js
  44. 0 packages/website/content/{ → docs}/guides/cloning-medium-with-parchment.mdx
  45. 0 packages/website/content/{ → docs}/guides/designing-the-delta-format.mdx
  46. +4 −4 packages/website/content/docs/installation.mdx
  47. 0 packages/website/content/{guides → docs}/upgrading-to-2-0.mdx
  48. 0 packages/website/content/{guides → docs}/why-quill.mdx
  49. +1 −1 packages/website/env.js
  50. +42 −0 packages/website/next.config.mjs
  51. +1 −1 packages/website/package.json
  52. +1 −1 packages/website/src/components/ActiveLink.jsx
  53. +4 −4 packages/website/src/components/GitHub.jsx
  54. +3 −11 packages/website/src/components/Header.jsx
  55. +6 −1 packages/website/src/components/Header.module.scss
  56. +0 −3 packages/website/src/components/Layout.jsx
  57. +12 −19 packages/website/src/components/PostLayout.jsx
  58. +9 −26 packages/website/src/components/PostLayout.module.scss
  59. +36 −4 packages/website/src/data/docs.tsx
  60. +0 −28 packages/website/src/data/guides.tsx
  61. +15 −0 packages/website/src/pages/docs.jsx
  62. +19 −4 packages/website/src/pages/docs/[...id].jsx
  63. +0 −52 packages/website/src/pages/guides/[...id].jsx
  64. +80 −64 packages/website/src/pages/index.jsx
  65. +166 −152 packages/website/src/pages/styles.scss
  66. +15 −0 packages/website/src/svg/users/airtable.svg
  67. +5 −0 packages/website/src/svg/users/apollo.svg
  68. +9 −0 packages/website/src/svg/users/calendly.svg
  69. +18 −0 packages/website/src/svg/users/figma.svg
  70. +15 −0 packages/website/src/svg/users/front.svg
  71. +2 −0 packages/website/src/svg/users/gem.svg
  72. +6 −0 packages/website/src/svg/users/grammarly.svg
  73. +9 −0 packages/website/src/svg/users/linkedin.svg
  74. +6 −0 packages/website/src/svg/users/microsoft.svg
  75. +2 −0 packages/website/src/svg/users/miro.svg
  76. +6 −0 packages/website/src/svg/users/mode.svg
  77. +20 −0 packages/website/src/svg/users/salesforce.svg
  78. +19 −0 packages/website/src/svg/users/slab.svg
  79. +14 −0 packages/website/src/svg/users/slack.svg
  80. +2 −0 packages/website/src/svg/users/typeform.svg
  81. +7 −0 packages/website/src/svg/users/vox-media.svg
  82. +9 −0 packages/website/src/svg/users/zoom.svg
  83. +68 −0 scripts/changelog.mjs
  84. +104 −131 scripts/release.js
  85. +8 −0 scripts/utils/configGit.mjs
  86. +1 −1 tsconfig.json
File renamed without changes.
26 changes: 14 additions & 12 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -2,26 +2,28 @@

The best way to contribute is to help others in the Quill community. This includes:

- Reporting new [bugs](https://github.com/quilljs/quill/labels/bug) or adding details to existing ones
- Reproducing [unconfirmed bugs](https://github.com/quilljs/quill/labels/needs%20reproduction)
- Reporting new [bugs](https://github.com/slab/quill/labels/bug) or adding details to existing ones
- Reproducing [unconfirmed bugs](https://github.com/slab/quill/labels/needs%20reproduction)
- Quick typo fix or documentation improvement [Pull Requests](#pull-requests)
- Participating in [discussions](https://github.com/quilljs/quill/labels/discussion)
- Answering questions on [StackOverflow](http://stackoverflow.com/questions/tagged/quill)
- Participating in [discussions](https://github.com/slab/quill/discussions)

After becoming familiar with Quill and the codebase, likely through using Quill yourself and making some of the above contributions, you may choose to take on a bigger commitment by:

- Helping fix [bugs](https://github.com/quilljs/quill/labels/bug)
- Implementing new [features](https://github.com/quilljs/quill/labels/feature)
- Helping fix [bugs](https://github.com/slab/quill/labels/bug)
- Implementing new [features](https://github.com/slab/quill/labels/feature)
- Publishing guides, tutorials, and examples
- Supporting Quill in other ecosystems (Angular, React, etc)

Note that if you are going to be making significant contributions, you should first open
a [discussion](https://github.com/slab/quill/discussions) to ensure your work aligns with the project's goals and direction.

## Questions

If you have a question, it is best to ask on StackOverflow and tag with [quill](http://stackoverflow.com/questions/tagged/quill). This tag is monitored by Quill maintainers and community members.
If you have a question, it is best to ask on [Discussions](https://github.com/slab/quill/discussions) under the Q&A category.

## Bug Reports

Search through [Github Issues](https://github.com/quilljs/quill/issues) to see if the bug has already been reported. If so, please comment with any additional information.
Search through [Github Issues](https://github.com/slab/quill/issues) to see if the bug has already been reported. If so, please comment with any additional information.

New bug reports must include:

@@ -35,7 +37,7 @@ Lacking reports it may be autoclosed with a link to these instructions.

## Feature Requests

Search through [Github Issues](https://github.com/quilljs/quill/labels/feature) to see if someone has already suggested the feature. If so, please provide support with a [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) and add your own use case.
Search through [Github Issues](https://github.com/slab/quill/labels/feature) to see if someone has already suggested the feature. If so, please provide support with a [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) and add your own use case.

To open a new feature request, please include:

@@ -50,20 +52,20 @@ The more complete and compelling the request, the more likely it will ultimately

## Pull Requests

Please check to make sure your plans fall within Quill's scope. This often means opening up a [discussion](https://github.com/quilljs/quill/labels/discussion).
Please check to make sure your plans fall within Quill's scope. This often means opening up a [discussion](https://github.com/slab/quill/labels/discussion).

Non-code Pull Requests such as typo fixes or documentation improvements are highly encouraged and are often accepted immediately.

Pull Requests modifying public facing interfaces or APIs, including backwards compatible additions, will undergo the most scrutiny, and will almost certainly require a proper discussion of the motivation and merits beforehand. Simply increasing code complexity is a cost not to be taken lightly.

Pull requests must:

1. Be forked off the [main](https://github.com/quilljs/quill/tree/main) branch.
1. Be forked off the [main](https://github.com/slab/quill/tree/main) branch.
2. Pass the linter and conform to existing coding styles.
3. Commits are [squashed](https://git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Squashing-Commits) to minimally coherent units of changes.
4. Are accompanied by tests covering the new feature or demonstrating the bug for fixes.
5. Serve a single atomic purpose (add one feature or fix one bug).
6. Introduce only changes that further the PR's singular purpose (ex. do not tweak an unrelated config along with adding your feature).
7. Not break any existing unit or end to end tests.

**Important:** By issuing a Pull Request you agree to allow the project owners to license your work under the terms of the [License](https://github.com/quilljs/quill/blob/master/LICENSE).
**Important:** By issuing a Pull Request you agree to allow the project owners to license your work under the terms of the [License](https://github.com/slab/quill/blob/master/LICENSE).
17 changes: 17 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
changelog:
exclude:
authors:
- quill-bot
categories:
- title: Bug Fixes 🛠
labels:
- change:bugfix
- title: New Features 🎉
labels:
- change:feature
- title: Documentation 📚
labels:
- change:documentation
- title: Other Changes
labels:
- "*"
10 changes: 6 additions & 4 deletions .github/workflows/_test.yml
Original file line number Diff line number Diff line change
@@ -17,18 +17,20 @@ jobs:
run: npx playwright install --with-deps
working-directory: packages/quill
- name: Run Playwright tests
run: npm run test:e2e
working-directory: packages/quill
uses: coactions/setup-xvfb@v1
with:
run: npm run test:e2e -- --headed
working-directory: packages/quill
fuzz:
name: Fuzz Tests
runs-on: ubuntu-latest

steps:
- name: Git checkout
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Use Node.js
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 20

22 changes: 22 additions & 0 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Generate Changelog

on:
release:
types: [published, created]
workflow_dispatch: {}

jobs:
changelog:
runs-on: ubuntu-latest
steps:
- name: Git checkout
uses: actions/checkout@v4
- name: Use Node.js
uses: actions/setup-node@v4
with:
node-version: 20

- run: npm ci
- run: node ./scripts/changelog.mjs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
24 changes: 24 additions & 0 deletions .github/workflows/label.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Pull Requests

on:
pull_request:
types: [opened, labeled, unlabeled, synchronize]

jobs:
label:
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- uses: mheap/github-action-required-labels@v5
with:
mode: exactly
count: 1
labels: |
change:bugfix
change:feature
change:documentation
change:chore
change:refactor
add_comment: false
7 changes: 5 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -13,6 +13,9 @@ on:
default: true
required: true

permissions:
contents: write

jobs:
test:
uses: ./.github/workflows/_test.yml
@@ -23,10 +26,10 @@ jobs:

steps:
- name: Git checkout
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Use Node.js
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 20

Loading