Enable favorites

Favorites is designed to be used with individual reader accounts, so we recommend only enabling it if your knowledge base has an option to log in. (If you are using Public Default access, enabling it won't hurt anything--anyone who's not logged in just won't see the star to favorite an article, and any article lists you add to display favorites will show empty for them.)

Getting favorites fully set up is generally a multi-step process, in which you:

  1. Enable the feature.
  2. Adjust your Article Custom HTML to be sure it has a merge code that includes the favorites action.
  3. Figure out where you'd like to display favorites in your theme: you can choose to add it to the table of contents or you can use a merge code to add to your homepage or right column, depending on your theme layout.

Steps 1 and 2 are outlined below; see the linked resources in step 3 for more details on those!

Enable favorites

Our default Editor role has permission to enable article favorites. If you're using a custom author role, that role must have the Admin Permission to Update article favorites settings.

To enable favorites in your knowledge base:

  1. Go to Settings > Article Favorites.
  2. Check the Enable article favorites checkbox to turn the feature on.
  3. While you're here, if you'd like to add favorites to your table of contents, you can also check the Show article favorites in the table of contents checkbox. (See Display favorites in the table of contents for more information.)
  4. Be sure to Save your changes.

Adjust your Article Custom HTML

Once you've turned on the feature, you also may need to make some tweaks to your article layout before you'll see the favorites star:

  1. Go to Settings > Style.
  2. Below the preview pane, be sure Custom HTML is selected.
  3. In the Custom HTML dropdown, select Article.
  4. In the Article Custom HTML, if you see the article("action_icons") template, you don't need to do anything else!
  5. If you don't see the article("action_icons") template, you probably have hard-coded HTML for your article actions, which usually looks like this:
  6. You have two options:
    1. You can highlight all of the HTML for the ko-article-actions span, remove it, and replace it with the article("action_icons") template. For more detailed instructions, see Update your article actions merge code.
    2. If you don't want to touch that HTML, you can add a new merge code into the HTML to enable the favorites icon. To do so:
      1. In the -- Select a Merge Code -- dropdown below the HTML pane, find the Article Merge Codes section.
      2. Select the Article Favorites Action from the dropdown.
      3. You can either put your cursor where you need in the HTML and hit the Insert button, or copy the merge code and paste it in.
      4. If your Article HTML looks like that in the screenshot above, you'll want to insert the merge code between the </a> and the </span>, like this:
  7. You can Preview your changes to be sure they look good.
  8. Just be sure to Save your changes once you're done!

Any one of these approaches should add a star in your article actions section as long as you enabled Favorites first:

Sample article favorites icon

Readers can click on that star to add it to their Favorites list.