IntegrationsVuepress
Add AI Search to your VuePress docs
What is VuePress
VuePress a markdown-centered static site generator.
Get an API key
- Go to the Inkeep Dashboard
- Select your project under Projects
- Go to the Integrations tab
- Click on Create integration
- Select Web
- Provide a Name.
- Specify a URL for where this integration will be used.
- For production API keys, leave Enforce referrer URL checked.
- Click on Create
- Click the Example < /> button to get your API key and view suggested settings
For local or staging API keys, see here.
Load the script files
- Navigate to the
.vuepress
directory - Add the below scripts to the
config.js
file:
Create the addInkeep.js script
Create an addInkeep.js
file in your public/js
folder.
Create container for search bar
To create a container for the search bar component, navigate to your desired page and add the following code:
Configure the component
Next, configure the Inkeep widget:
For a full list of customizations, check out the Search Bar documentation.