IntegrationsMkdocs
Add AI Chat to your MkDocs docs
What is MkDocs
MkDocs is a platform for creating documentation with markdown.
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.
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:
For a full list of customizations, check out the Chat Button documentation.