{"id":22048569,"url":"https://github.com/samhammerag/ckeditor5-internallink-plugin","last_synced_at":"2025-05-08T23:02:52.008Z","repository":{"id":47077646,"uuid":"141975143","full_name":"SamhammerAG/ckeditor5-internallink-plugin","owner":"SamhammerAG","description":"A generic ckeditor plugin to create link tags containing an identifier instead of a url","archived":false,"fork":false,"pushed_at":"2023-02-14T00:36:39.000Z","size":499,"stargazers_count":5,"open_issues_count":3,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-03-02T05:55:48.052Z","etag":null,"topics":["ckeditor5"],"latest_commit_sha":null,"homepage":"","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/SamhammerAG.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-23T07:05:33.000Z","updated_at":"2021-11-10T04:48:27.000Z","dependencies_parsed_at":"2023-01-25T15:31:29.502Z","dependency_job_id":null,"html_url":"https://github.com/SamhammerAG/ckeditor5-internallink-plugin","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamhammerAG%2Fckeditor5-internallink-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamhammerAG%2Fckeditor5-internallink-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamhammerAG%2Fckeditor5-internallink-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SamhammerAG%2Fckeditor5-internallink-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SamhammerAG","download_url":"https://codeload.github.com/SamhammerAG/ckeditor5-internallink-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227351655,"owners_count":17768412,"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":["ckeditor5"],"created_at":"2024-11-30T14:12:47.701Z","updated_at":"2024-11-30T14:12:48.369Z","avatar_url":"https://github.com/SamhammerAG.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n# ckeditor5-internallink-plugin\nA generic ckeditor plugin to create custom html tags containing an identifier to a referenced item.\nThe referencable items are found by an autocomplete input.\n\n## Overview\nThis plugin has the same features as the default link plugin except that it does not create regular link tags.\n\n![alt text](https://raw.githubusercontent.com/SamhammerAG/ckeditor5-internallink-plugin/master/README_Autocomplete.png)\n\nThe HTML-Tags of this plugin are looking as following:\n\n```\n\u003cinternallink internallinkid=\"123\"\u003esome text\u003c/internallink\u003e\n```\n\n![alt text](https://raw.githubusercontent.com/SamhammerAG/ckeditor5-internallink-plugin/master/README_Preview.png)\n\n## Features\n\n - Create and edit links\n - Remove links\n - Configurable autocomplete to find the referenceable item\n - Show a label (title) instead of the item id\n - Open the referenced item in a new tab\n - If text is marked the link will be added to it. Otherwise the item title with a link will be added to the text.\n - Configurable webservice urls to get the required data\n - Test mode to test the plugin without having to implement a webservice\n\n## How to use\nTo be able to use this plugin you need a custom build of ckeditor.\n\nFurther instructions can be found here:\nhttps://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/installing-plugins.html\n\nAdd the NPM-Package (https://www.npmjs.com/package/@samhammer/ckeditor5-internallink-plugin) by running one of the following commands (depending on your build environment):\n\n```bash\nyarn add @samhammer/ckeditor5-internallink-plugin\nnpm i @samhammer/ckeditor5-internallink-plugin\n```\n\ne.g.: https://github.com/SamhammerAG/ssp-ckeditor5-build-inline\n\nNote: We prefer yarn so it is only testet with this build tool.\n\n## Configuration\nConfiguration flags:\n\n| Flag name | Description | Example |\n| --- | --- | --- |\n| testmode | If set to true the plugin can be tested without autocompleteurl and titleurl | true or false |\n| autocompleteurl | Configure a json webservice that returns the autocomplete suggestions. The placeholder **{searchTerm}** is replaced by the search term that is entered to the autocomplete textbox. | http://www.example.com/autocomplete?term={searchTerm} |\n| titleurl | Configure a json webservice that returns the title for a referenced item. This service is called on editing an existing link. The placeholder **{internalLinkId}** is replaced by the id of the referenced item. | http://www.example.com/gettitle?itemid={internalLinkId} |\n| previewurl | The url that is used to open a preview of the referenced item in a new tab. The placeholder **{internalLinkId}** is replaced by the id of the referenced item. | http://www.google.de?q={internalLinkId} |\n| axiosInstance | This instance is used to call the autocomplete and the title url. You can use a custom instance e.g if you need interceptors for authentication. | import axios from \"axios\" and use this axios instance |\n\nExample:\n\n```js\nInlineEditor\n\t.create( editorElement, {\n\t\tinternallink: {\n\t\t\ttestmode: false,\n\t\t\tautocompleteurl: '',\n\t\t\ttitleurl: '',\n\t\t\tpreviewurl: '',\n\t\t\taxiosInstance: undefined\n\t\t}\n\t} )\n\t.then( ... )\n\t.catch( ... );\n```\n\n## Webservice response data format\n\nThis plugin requires webservices that are returning json data.\nWe are using axios to do HTTP-GET requests.\n\n### Autocomplete response\n\n```\n[\n    { label:  'Text1', value:  '1' },\n    { label:  'Text2', value:  '2' }\n]\n```\n\n### Get title response\n\nReturns a string with the title\n\n## How to develop\n\nFor local development you can checkout this package to the \"packages\" folder of our inline build. Just follow these instructions:\nhttps://github.com/SamhammerAG/ssp-ckeditor5-build-inline\n\n## How to publish\n\nFor publishing an npm account that is referenced to the organization is required.\n\nSee the following how to:\n\nhttps://yarnpkg.com/en/docs/publishing-a-package\n\nhttps://docs.npmjs.com/getting-started/publishing-npm-packages\n\nIf everything is configured correctly just count up the version number in our package.json and execute one of the following commands:\n\n```bash\nyarn publish\nnpm publish --access public\n```\n\n## License\n\nckeditor5-internallink-plugin is released under the MIT License. See LICENSE file for details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamhammerag%2Fckeditor5-internallink-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsamhammerag%2Fckeditor5-internallink-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsamhammerag%2Fckeditor5-internallink-plugin/lists"}