From 672e33177bb45de4967ea8352f29ee42ec1360ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Colin=20D=C3=B6rr?= Date: Sat, 8 Jun 2024 12:05:40 +0200 Subject: [PATCH] Chore: use absolute image urls in readme --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0d57543..edba94b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Welcome to the `Better Linking` plugin! This DatoCMS plugin allows you to easily create a complex link field, containing different link types (records, assets, URLs, email links, or telephone numbers), custom styling, control over the link target, and the ability to override the link text with a custom value. -![](/docs/cover.png) +![](https://raw.githubusercontent.com/ColinDorr/datocms-plugin-better-linking/main/docs/cover.png) ## Installation 1. Install the plugin. @@ -16,17 +16,17 @@ This DatoCMS plugin allows you to easily create a complex link field, containing 7. Save the settings and the field. 8. You can now add this field to your site and start using it. -![cms plugin settings](/docs/cms-settings.png) +![cms plugin settings](https://raw.githubusercontent.com/ColinDorr/datocms-plugin-better-linking/main/docs/cms-settings.png) ## How it works After installing the plugin and creating a new field (see installation instructions), you can start using the new `Better Linking` field. `Better Linking` allows you to set default settings in the plugin window and customize those settings for each field in the field appearance window. The settings of the plugin, field, and its content will be saved as a JSON object. The JSON data will be hidden in the CMS/frontend and will be replaced with a user-friendly UI, which helps the user to easily create a link with customized data, giving them more control over their links. -![preview userfriendly link ui](/docs/preview.png) +![preview userfriendly link ui](https://raw.githubusercontent.com/ColinDorr/datocms-plugin-better-linking/main/docs/preview.png) ## Development When using the plugin, a JSON data object will be generated with all the settings and filled-in content. This data will be hidden in the CMS/frontend but is accessible using GraphQL and the CDA Playground. When querying the data of a `Better Linking` field, the whole JSON data object will be returned, containing all the data and selected options, allowing developers full access to the detailed information of the link. This might look a bit intimidating at first glance, but don't be scared. In the JSON data object, you will also find an object called `formatted`. This object contains a minimized representation of all link data. In most cases, this data will be more than enough to handle your links. -![formatted response](/docs/formatted-response.png) \ No newline at end of file +![formatted response](https://raw.githubusercontent.com/ColinDorr/datocms-plugin-better-linking/main/docs/formatted-response.png) \ No newline at end of file