IntegrationsMkdocs
Add Chat Button to MkDocs
Integrate Inkeep's chat button into your MkDocs documentation for real-time user assistance.
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 inkeep-button.js
. Add path to this file to the mkdocs.yml
:
Then add the button:
Note
You will need to replace REPLACE_WITH_YOUR_INKEEP_API_KEY
with your actual
Inkeep API key in the code below.
For a full list of customizations, check out the Chat Button documentation.