{"id":13535661,"url":"https://github.com/patleeman/quill-markdown-shortcuts","last_synced_at":"2026-04-16T04:06:58.622Z","repository":{"id":41203264,"uuid":"100373024","full_name":"patleeman/quill-markdown-shortcuts","owner":"patleeman","description":"Quill.js module that converts markdown to rich text formatting while typing.","archived":false,"fork":false,"pushed_at":"2022-12-04T04:50:26.000Z","size":1192,"stargazers_count":140,"open_issues_count":21,"forks_count":49,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-03T00:32:43.131Z","etag":null,"topics":["javascript","markdown","quilljs"],"latest_commit_sha":null,"homepage":"https://patleeman.github.io/quill-markdown-shortcuts/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/patleeman.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-15T12:01:19.000Z","updated_at":"2024-09-26T00:35:47.000Z","dependencies_parsed_at":"2023-01-24T00:03:30.460Z","dependency_job_id":null,"html_url":"https://github.com/patleeman/quill-markdown-shortcuts","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patleeman%2Fquill-markdown-shortcuts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patleeman%2Fquill-markdown-shortcuts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patleeman%2Fquill-markdown-shortcuts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/patleeman%2Fquill-markdown-shortcuts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/patleeman","download_url":"https://codeload.github.com/patleeman/quill-markdown-shortcuts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246743566,"owners_count":20826555,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["javascript","markdown","quilljs"],"created_at":"2024-08-01T09:00:20.386Z","updated_at":"2026-04-16T04:06:58.609Z","avatar_url":"https://github.com/patleeman.png","language":"JavaScript","funding_links":[],"categories":["Uncategorized"],"sub_categories":["Uncategorized"],"readme":"# Quill Markdown Shortcuts\n\nThis package is a [Quill.js](https://quilljs.com) module that converts markdown on the fly to formatted rich text.\n\n[Example](https://patleeman.github.io/quill-markdown-shortcuts/)\n\n# Quickstart\n\n## Installation\n\n### Using NPM\n\nUse the NPM package manager to add this dependency to your project.\n\n```bash\nnpm i -S quill-markdown-shortcuts\n```\n\n### Using CDN\n\nAdd the library via jsdelivr.\n\n```\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/quill-markdown-shortcuts@latest/dist/markdownShortcuts.js\"\u003e\n```\n\n### By downloading file\n\nTo incorporate the code into your codebase, simply download the markdownShortcuts.js file and include that in your build process or link a script tag to it directly. Then set up quill and make sure to include the markdownShortcuts setting in modules.\n\n## Usage\n\n### ES6\n\n```js\nimport Quill from 'quill';\nimport MarkdownShortcuts from 'quill-markdown-shortcuts';\n\nQuill.register('modules/markdownShortcuts', MarkdownShortcuts);\n\nconst quill = new Quill('#editor', {\n  theme: 'snow',\n  // All you need to do to enable the module is to add a modules key\n  // to your quill configuration, and add markdownShortcuts with an\n  // empty object.\n  // There are currently no options to set.\n  modules: {\n    markdownShortcuts: {}\n  }\n});\n```\n\n### Script Tag\n\n```html\n\u003cbody\u003e\n  \u003cdiv class=\"container\"\u003e\n    \u003cdiv id=\"editor\"\u003e\u003c/div\u003e\n    \u003cscript src=\"/path/to/node_modules/quill-markdown-shortcuts/dist/markdownShortcuts.js\"\u003e\u003c/script\u003e\n    \u003cscript\u003e\n      var quill = new Quill('#editor', {\n        theme: 'snow',\n        // All you need to do to enable the module is to add a modules key\n        // to your quill configuration, and add markdownShortcuts with an\n        // empty object.\n        // There are currently no options to set.\n        modules: {\n          markdownShortcuts: {}\n        }\n      });\n    \u003c/script\u003e\n  \u003c/div\u003e\n\u003c/body\u003e\n```\n\n# Contributing\n\nIssues and pull requests are welcome! Please [open an issue](https://github.com/patleeman/quill-markdown-shortcuts/issues) for all other inquiries.\n\n## Building the module and examples\n\nTo build the module and the example bundles, please run `npm run build` and include the bundles in your commit. Thanks!\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatleeman%2Fquill-markdown-shortcuts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpatleeman%2Fquill-markdown-shortcuts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpatleeman%2Fquill-markdown-shortcuts/lists"}