Step 1: Apply the Knowledge Base Starter

Prerequisites

Before installing this starter, ensure you have set up the below steps:

1. You must have access to the Yext Github organization: https://github.com/yext
   
2. You must have access to the Yext NPM organization: https://www.npmjs.com/org/yext
   
3. Have the Yext CLI installed: https://hitchhikers.yext.com/guides/cli-getting-started-resources/01-install-cli/
   
4. Have Deno installed, version 1.21.0 or later: https://deno.land/manual/getting_started/installation
   
5. Have node installed, version 17 or later: https://nodejs.org/en/download/
   
   • It’s recommend to use nvm: https://github.com/nvm-sh/nvm#installing-and-updating or via brew brew install nvm.
6. Optional: Have a Yext account (necessary for production builds, deploying on Yext Sites, and pulling local stream document data via yext sites generate-test-data). This starter already comes with some localData that can be used for local dev without the need to init with a Yext account.

Steps to Install

1. Navigate to the Solutions tab in your Knowldge Graph.
2. Select the Knowledge Base Starter tile.
3. Click View Solution. You will be redirected to the Admin Console. In the Admin Console, click Apply. You will be prompted to input your business ID. Click continue. You may need to click Start Authorization Flow. Click through the flow, and then click Apply.
4. Check out the new Search experience, Pages experience, and seed data that has been added to your Knowledge Graph!

Customizable Components

You can choose to customize this Starter however best fits your use case. For instructions on how to edit the built-in features of the site, see below.

Card, Folder, and Board Entities

Delete the test entities that were added when you installed the Starter, and create your own Card, Board, and Folder entities. You can then map each entity to related entities using the built-in entity relationship fields.

Home Page

You can add new functionality or sections to the home page below the search bar as needed. Refer to our Pages documentation for more detail.

Header

• Feedback button
  • Swap out the link on line 51 of the Header.tsx file to add your own survey form to the header.
• Help button
  • Swap out the link on line 52 of the Header.tsx file to add your own Help link to the header.
• Add company logo to header
  • Comment in line 183 in the search.tsx file and add the link to the logo of your choosing.
• ⌘ K
  • The ⌘ K functionality searches against a vertical that includes all entity types (Card, Folder, Board), but is hidden in the search experience itself. If you would like to edit this vertical, you can make changes to the Knowledge Base Autocomplete (Key: kb_autocomplete) vertical in the search configuration.

Cards

• Star Board button
  • Update star.ts file to include functionality for users to star a board based on permissions.
• Edit button
  • Depending on your desired user permissions, users of your internal Knowledge Base site can edit cards if granted the appropriate permissions in your Yext account. Update as needed.

Analytics Dashboards

This starter includes a basic Pages and Search analytics dashboard. To further customize, follow this guide .