npmpackage.info

Gathering detailed insights and metrics for quilljs-markdown

quilljs-markdown

QuillJS Editor Plugin for advanced Markdown

1.2.0

179

MIT

JavaScript

5.53 kB

1,168,797 3.2

Installations

npm install quilljs-markdown

Pull Requests

Open

1

Total

34

Closed

1

Merged

32

Issues

Open

16

Total

45

Closed

29

Releases

1.2.0 Support Safari browser and small bug fixed.

1.2.0

Published on 21 Jul 2022

1.1.11 Fix bug - does not working markdown syntax for link

1.1.11

Published on 08 May 2022

1.1.10 Add destroy() method to disable markdown

1.1.10

Published on 12 Dec 2021

1.1.9 Bug fixed for support safari browser

1.1.9

Published on 02 Dec 2021

1.1.8 Improving code block and Fixed bold syntax below block element.

1.1.8

Published on 19 Nov 2021

1.1.7 Fix incorrect for inline code section

1.1.7

Published on 27 Oct 2021

View all 15 releases

Developer

cloverhearts

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

No

Node Version

12.16.1

NPM Version

6.13.4 Statistics

179 Stars

113 Commits

26 Forks

3 Watching

1 Branches

6 Contributors

Updated on 27 Nov 2024

Bundle Size

23.22 kB

Minified

5.53 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (96.55%)

SCSS (3.45%)

Total Downloads

Cumulative downloads

Total Downloads

1,168,797

Last day

-29.2%

1,652

Compared to previous day

Last week

-9.1%

10,942

Compared to previous week

Last month

7.1%

49,922

Compared to previous month

Last year

-16.8%

444,004

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

core-js regenerator-runtime

Dev Dependencies

@babel/core @babel/preset-env @babel/register babel-loader jest npm-run-all parcel-bundler quill rimraf sass snazzy standard uglifyjs-webpack-plugin webpack webpack-cli

Versions

Markdown for Quill Editor

QuillJS Markdown shortcut Extension.

NPM

DEMO

Wrote Library with ES6 and Standard Javascript Codestyle.

How to install

NPM

npm i quilljs-markdown

CDN

<script src="https://cdn.jsdelivr.net/npm/quilljs-markdown@latest/dist/quilljs-markdown.js"></script>

How to use

1import Quill from 'quill'
2import QuillMarkdown from 'quilljs-markdown'
3import 'quilljs-markdown/dist/quilljs-markdown-common-style.css' // recommend import css, @option improve common style
4
5const options = {
6  theme: 'snow'
7}
8
9document.addEventListener('DOMContentLoaded', () => {
10  const editor = new Quill('#editor', options)
11  const markdownOptions = {
12    /**
13     ignoreTags: [ 'pre', 'strikethrough'], // @option - if you need to ignore some tags.
14     
15     tags: { // @option if you need to change for trigger pattern for some tags. 
16      blockquote: {
17        pattern: /^(\|){1,6}\s/g,
18      },
19      bold: {
20        pattern:  /^(\|){1,6}\s/g,
21      },
22      italic: {
23        pattern: /(\_){1}(.+?)(?:\1){1}/g,
24      },
25    },
26    */
27  };
28  
29  // markdown is enabled
30  const quillMarkdown = new QuillMarkdown(editor, markdownOptions)
31  
32  // markdown is now disabled  
33  // quillMarkdown.destroy()
34  
35})
36
37

Javascript 2 (Enable to Standard style for Quilljs)

1import Quill from 'quill'
2import QuillMarkdown from '../src/app'
3
4const toolbarOptions = [
5  ['bold', 'italic', 'underline', 'strike'],
6  [ 'link', 'image'],          // add's image support
7];
8
9const options = {
10  theme: 'snow',
11  modules: {
12    toolbar: toolbarOptions,
13    QuillMarkdown: {
14       ignoreTags: [ 'pre', 'strikethrough'], // @option - if you need to ignore some tags.
15       
16       tags: { // @option if you need to change for trigger pattern for some tags. 
17        blockquote: {
18          pattern: /^(\|){1,6}\s/g,
19        },
20        bold: {
21          pattern:  /^(\|){1,6}\s/g,
22        },
23        italic: {
24          pattern: /(\_){1}(.+?)(?:\1){1}/g,
25        },
26      },
27    }
28  }
29}
30
31document.addEventListener('DOMContentLoaded', () => {
32  console.log('HOHO')
33
34  Quill.register('modules/QuillMarkdown', QuillMarkdown, true)
35
36  new Quill('#editor', options)
37})
38

HTML

1
2<script src="https://cdn.quilljs.com/1.3.6/quill.js"></script>
3<script src="https://cdn.jsdelivr.net/npm/quilljs-markdown@latest/dist/quilljs-markdown.js"><script>
4<link href="https://cdn.quilljs.com/1.3.6/quill.snow.css" rel="stylesheet">
5<link href="https://cdn.jsdelivr.net/npm/quilljs-markdown@latest/dist/quilljs-markdown-common-style.css" rel="stylesheet" >
6
7<script>
8    document.addEventListener('DOMContentLoaded', () => {
9      var quill = new Quill('#editor', {
10        theme: 'snow'
11      });
12      var markdownOptions = {
13        ignoreTags: [ 'strikethrough'], // @option - if you need to ignore some tags.
14    
15        tags: { // @option if you need to change for trigger pattern for some tags. 
16        blockquote: {
17          pattern: /^(\|){1,6}\s/g,
18        },
19        bold: {
20          pattern:  /^(\|){1,6}\s/g,
21        },
22        italic: {
23          pattern: /(\_){1}(.+?)(?:\1){1}/g,
24        },
25      },
26    };
27      new QuillMarkdown(editor, markdownOptions)
28    })
29<script>
30

destroy

Call destroy() to remove the event listener and disable markdown support:

const quillMarkdown = new QuillMarkdown(editor, markdownOptions)
// markdown is enabled

quillMarkdown.destroy()
// markdown is now disabled

To re-enable support, create a new instance.

Paste support for Markdown format.

Pasting the Markdown form,

Shows the corresponding Markdown result.

Heading (tagname : h1, h2, h3 ,h4, h5, h6, header(all))

1# MyTitle
2## MyTitle
3### MyTitle
4#### MyTitle
5##### MyTitle

Blockquote (tagname : blockquote)

1> blockquote text

bold (tagname : bold)

1**Bold Text**
2__Bold Text__

Italic (tagname : italic)

1*Italics Text*
2_Italics Text_

Link (tagname : link)

1[link text](https://link_url)

inline code (tagname : code)

1`inline code block`

Code block (tagname : pre)

```
code block
```

List (tagname : ol, ul)

11. one
22. two
33. three
4
5* one
6* two
7* three

Strikethrough (tagname : strikethrough)

1~~Strikethrough~~

Checkbox (tagname : checkbox)

1[ ] checkbox
2[x] checked

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

52 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-4943-9vgg-gr5r
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-h9rv-jmmf-4pgx
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh

Score

3.2

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More