IntegrationsMkdocs
Add Chat and Search to MkDocs
Integrate Inkeep's chat button and search bar into your MkDocs documentation for enhanced user experience.
What is MkDocs
MkDocs is a platform for creating documentation with markdown.
Get an API key
Follow these steps to create an API key for your web integration.
Initialize the widget
In docs folder create a custom js file, for example button-and-search-bar.js
. Add path to this file to the mkdocs.yml
and disable default search bar with plugins: []
:
Then add the button and search bar:
For a full list of customizations, check out the Common Settings.