{"_id":"@yunger/tiptap-markdown","name":"@yunger/tiptap-markdown","dist-tags":{"latest":"0.8.10"},"versions":{"0.8.10":{"name":"@yunger/tiptap-markdown","version":"0.8.10","description":"Edit markdown content in tiptap editor.","workspaces":["example"],"main":"dist/tiptap-markdown.umd.js","module":"dist/tiptap-markdown.es.js","type":"module","sideEffects":false,"exports":{".":{"import":"./dist/tiptap-markdown.es.js","require":"./dist/tiptap-markdown.umd.js","types":"./index.d.ts"}},"browserslist":["defaults","not IE 11"],"repository":{"type":"git","url":"git+https://github.com/aguingand/tiptap-markdown.git"},"bugs":{"url":"https://github.com/aguingand/tiptap-markdown/issues"},"types":"index.d.ts","author":{"name":"Antoine Guingand"},"license":"MIT","dependencies":{"@types/markdown-it":"^13.0.7","markdown-it":"^14.1.0","markdown-it-task-lists":"^2.1.1","prosemirror-markdown":"^1.11.1"},"peerDependencies":{"@tiptap/core":"^2.0.3"},"devDependencies":{"@babel/core":"^7.23.2","@babel/preset-env":"^7.23.2","@rollup/plugin-babel":"^5.3.1","@tiptap/core":"^2.2.6","@tiptap/extension-highlight":"^2.2.6","@tiptap/extension-image":"^2.2.6","@tiptap/extension-link":"^2.2.6","@tiptap/extension-table":"^2.2.6","@tiptap/extension-table-cell":"^2.2.6","@tiptap/extension-table-header":"^2.2.6","@tiptap/extension-table-row":"^2.2.6","@tiptap/extension-task-item":"^2.2.6","@tiptap/extension-task-list":"^2.2.6","@tiptap/extension-underline":"^2.2.6","@tiptap/pm":"^2.2.6","@tiptap/starter-kit":"^2.2.6","@tiptap/vue-3":"^2.2.6","@types/jest":"^28.1.7","jest-serializer-html":"^7.1.0","jsdom":"^22.1.0","terser":"^5.24.0","update-by-scope":"^1.1.3","vite":"^5.2.8","vitest":"^1.4.0"},"scripts":{"test":"vitest","dev":"vite example","build":"vite build","build:example":"vite build example","preview":"vite preview example","preversion":"npm run build","update:tiptap":"update-by-scope @tiptap"},"_id":"@yunger/tiptap-markdown@0.8.10","homepage":"https://github.com/aguingand/tiptap-markdown#readme","_integrity":"sha512-dvEYhHuYpTiWXwn3OAPqf97YaDBHKhMU3XjODIGbwe8zg+HyISADWmdFvGFcecrU97cKUWJ65FBpkaS5AyFNQQ==","_resolved":"/tmp/1419cd701a1c4650232035115cefdefc/yunger-tiptap-markdown-0.8.10.tgz","_from":"file:yunger-tiptap-markdown-0.8.10.tgz","_nodeVersion":"22.12.0","_npmVersion":"10.9.0","dist":{"integrity":"sha512-dvEYhHuYpTiWXwn3OAPqf97YaDBHKhMU3XjODIGbwe8zg+HyISADWmdFvGFcecrU97cKUWJ65FBpkaS5AyFNQQ==","shasum":"1e10f5c7f43aed23a2a8680c438bf25e6202ba64","tarball":"https://registry.npmjs.org/@yunger/tiptap-markdown/-/tiptap-markdown-0.8.10.tgz","fileCount":41,"unpackedSize":238185,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIDSlLUSfPzjxcPDPx6vROtjqcvvML9j9oeCbA1xejXF4AiEA92IS6GbXbDEaKGZfDCUaldDq3ZLtjObobY36ZCIxcXo="}]},"_npmUser":{"name":"yunger","email":"luisgalete6264@gmail.com"},"directories":{},"maintainers":[{"name":"yunger","email":"luisgalete6264@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/tiptap-markdown_0.8.10_1748442372729_0.05238142027951387"},"_hasShrinkwrap":false}},"time":{"created":"2025-05-28T14:26:12.662Z","0.8.10":"2025-05-28T14:26:12.958Z","modified":"2025-05-28T14:26:13.208Z"},"maintainers":[{"name":"yunger","email":"luisgalete6264@gmail.com"}],"description":"Edit markdown content in tiptap editor.","homepage":"https://github.com/aguingand/tiptap-markdown#readme","repository":{"type":"git","url":"git+https://github.com/aguingand/tiptap-markdown.git"},"author":{"name":"Antoine Guingand"},"bugs":{"url":"https://github.com/aguingand/tiptap-markdown/issues"},"license":"MIT","readme":"> [!WARNING]\nAs Tiptap have now a solution for markdown (paid [Conversion extension](https://next.tiptap.dev/docs/conversion/import-export/markdown/editor-extensions) and more markdown handling [announced for v3](https://next.tiptap.dev/docs/resources/whats-new#whats-next-in-tiptap-3x)). I don't plan to release [v1](https://github.com/aguingand/tiptap-markdown/pull/67) nor addressing current issues / PR. Feel free to fork the project if you need.\n\n# Tiptap markdown\n\nThe markdown extension for [Tiptap editor](https://www.tiptap.dev/).\n\n## Installation\n\n```bash\nnpm install tiptap-markdown\n```\n\n### Requirements\nSupports all frameworks handled by Tiptap (Vue 2, Vue 3, React, [see full list](https://www.tiptap.dev/installation#integration-guides)...)\n\n## Usage\nBasic example:\n\n```js\nimport { Editor } from '@tiptap/core';\nimport StarterKit from '@tiptap/starter-kit';\nimport { Markdown } from 'tiptap-markdown';\n\nconst editor = new Editor({\n    content: \"# Title\",\n    extensions: [\n        StarterKit,\n        Markdown,\n    ],\n});\nconst markdownOutput = editor.storage.markdown.getMarkdown();\n```\n\n## API\n\n### Options\nDefault options:\n```js\nMarkdown.configure({\n  html: true,                  // Allow HTML input/output\n  tightLists: true,            // No <p> inside <li> in markdown output\n  tightListClass: 'tight',     // Add class to <ul> allowing you to remove <p> margins when tight\n  bulletListMarker: '-',       // <li> prefix in markdown output\n  linkify: false,              // Create links from \"https://...\" text\n  breaks: false,               // New lines (\\n) in markdown input are converted to <br>\n  transformPastedText: false,  // Allow to paste markdown text in the editor\n  transformCopiedText: false,  // Copied text is transformed to markdown\n})\n```\n\n### Methods\n```js\neditor.commands.setContent('**test**') // setContent supports markdown format\neditor.storage.markdown.getMarkdown(); // get current content as markdown\n```\n\n### Custom extensions\nSee [examples](https://github.com/aguingand/tiptap-markdown/tree/main/example/src/extensions).  \nCheck out prosemirror-markdown [default serializer](https://github.com/ProseMirror/prosemirror-markdown/blob/master/src/to_markdown.ts#L66) for examples of serialize config. Check out markdown-it [plugins](https://github.com/markdown-it/markdown-it#syntax-extensions) for parsing.\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\nThe MIT License (MIT). Please see [License File](LICENSE) for more information.\n","readmeFilename":"README.md","_rev":"1-d25ff0e0cad5323847860bad91d4021b"}