{"id":22404601,"url":"https://github.com/kommitters/editorjs-break-line","last_synced_at":"2025-07-23T16:12:26.506Z","repository":{"id":42658571,"uuid":"268919519","full_name":"kommitters/editorjs-break-line","owner":"kommitters","description":"Break Line and divider Tool for Editor.js.","archived":false,"fork":false,"pushed_at":"2024-04-08T18:34:14.000Z","size":1025,"stargazers_count":9,"open_issues_count":3,"forks_count":7,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-04-13T20:30:25.781Z","etag":null,"topics":["editorjs","editorjs-tool","javascript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/editorjs-break-line","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kommitters.png","metadata":{"funding":{"github":["kommitters"]},"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-06-02T22:13:43.000Z","updated_at":"2024-04-15T15:14:16.781Z","dependencies_parsed_at":"2023-10-13T02:47:27.055Z","dependency_job_id":"e2550f59-9c99-461a-bb3a-912d291e551e","html_url":"https://github.com/kommitters/editorjs-break-line","commit_stats":{"total_commits":55,"total_committers":13,"mean_commits":4.230769230769231,"dds":0.6727272727272727,"last_synced_commit":"8b1cf6b65b1894f4394da2be13a8b2f8a315a549"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kommitters%2Feditorjs-break-line","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kommitters%2Feditorjs-break-line/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kommitters%2Feditorjs-break-line/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kommitters%2Feditorjs-break-line/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kommitters","download_url":"https://codeload.github.com/kommitters/editorjs-break-line/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228275014,"owners_count":17895008,"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":["editorjs","editorjs-tool","javascript"],"created_at":"2024-12-05T10:14:07.190Z","updated_at":"2024-12-05T10:14:07.872Z","avatar_url":"https://github.com/kommitters.png","language":"JavaScript","funding_links":["https://github.com/sponsors/kommitters"],"categories":[],"sub_categories":[],"readme":"# EditorJS BreakLine Tool\n\n![stability-stable](https://img.shields.io/badge/stability-stable-green.svg)\n![](https://badgen.net/badge/Editor.js/v2.0/blue)\n[![Coverage Status](https://coveralls.io/repos/github/kommitters/editorjs-break-line/badge.svg)](https://coveralls.io/github/kommitters/editorjs-break-line)\n[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6467/badge)](https://bestpractices.coreinfrastructure.org/projects/6467)\n[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/kommitters/editorjs-break-line/badge)](https://api.securityscorecards.dev/projects/github.com/kommitters/editorjs-break-line)\n\nBreak Line and divider Tool for [Editor.js](https://editorjs.io).\n\n![](assets/demo.gif)\n\n## Notes\n\n- Adds an empty block\n- Adds a divider block\n- Keyboard shortcut `CMD+SHIFT+ENTER`\n\n## Installation\n\n### Install via NPM\nGet the package\n```shell\n$ npm i --save-dev editorjs-break-line\n```\n\nInclude module at your application\n\n```javascript\nimport BreakLine from 'editorjs-break-line';\n```\n\n### Load from CDN\n\nYou can load a specific version of the package from [jsDelivr CDN](https://www.jsdelivr.com/package/npm/editorjs-break-line).\n\nRequire this script on a page with Editor.js.\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/editorjs-break-line\"\u003e\u003c/script\u003e\n```\n\n## Usage\n\nAdd a new Tool to the `tools` property of the Editor.js initial config.\n\n```javascript\nconst editor = EditorJS({\n  tools: {\n    breakLine: {\n      class: BreakLine,\n      inlineToolbar: true,\n      shortcut: 'CMD+SHIFT+ENTER',\n    },\n  }\n});\n```\n\n## Config Params\n\nNo config params required.\n\n## Tool's tunes\n\n1. Add a divider line\n\n## Output data\n\n| Field          | Type      | Description                     |\n| -------------- | --------- | ------------------------------- |\n| divider        | `boolean` | Add a divider line\n\n**Data**\n\n```json\n{\n  \"type\": \"breakLine\",\n  \"data\": {\n      \"divider\": true\n  }\n},\n```\n\n## Development\n\n**Development mode**\n```shell\n$ yarn build:dev\n```\n\n**Production release**\n1. Create a production bundle\n```shell\n$ yarn build\n```\n\n2. Commit `dist/bundle.js`\n\n**Run tests**\n```shell\n$ yarn test\n```\n\n## Code of conduct\nWe welcome everyone to contribute. Make sure you have read the [CODE_OF_CONDUCT][coc] before.\n\n## Contributing\nFor information on how to contribute, please refer to our [CONTRIBUTING][contributing] guide.\n\n## Changelog\nFeatures and bug fixes are listed in the [CHANGELOG][changelog] file.\n\n## License\nThis library is licensed under an MIT license. See [LICENSE][license] for details.\n\n## Acknowledgements\nMade with 💙 by [kommitters Open Source](https://kommit.co)\n\n[license]: https://github.com/kommitters/editorjs-break-line/blob/master/LICENSE\n[coc]: https://github.com/kommitters/editorjs-break-line/blob/master/CODE_OF_CONDUCT.md\n[changelog]: https://github.com/kommitters/editorjs-break-line/blob/master/CHANGELOG.md\n[contributing]: https://github.com/kommitters/editorjs-break-line/blob/master/CONTRIBUTING.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkommitters%2Feditorjs-break-line","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkommitters%2Feditorjs-break-line","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkommitters%2Feditorjs-break-line/lists"}