www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/linkit/README.md

   1 Linkit
   2 ===========
   3 Linkit provides an **enriched linking experience for internal and external
   4 linking** with editors by using an autocomplete field. Linkit has by default
   5 support for nodes, users, taxonomy terms, files, comments and
   6 **basic support for all types of entities** that defines a canonical link
   7 template.
   8
   9
  10 Installation
  11 ------------
  12
  13 * Normal module installation procedure. See
  14   https://www.drupal.org/documentation/install/modules-themes/modules-8
  15
  16
  17 Configuration
  18 ------------
  19
  20 After the installation, you have to create a Linkit profile. The profile will
  21 contain information about which plugins to use.
  22 Profiles can be created at `/admin/config/content/linkit`
  23
  24 When you have created a profile, you need to enable the Linkit plugin on the
  25 text format you want to use. Formats are found at
  26 `admin/config/content/formats`.
  27
  28
  29 Plugins examples
  30 ------------
  31
  32 There are plugin implementation examples in the linkit_test module bundled with
  33 Linkit core.