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 and URL (optional) for the integration
- Click on Create
- Click the Example < /> button to get your API key and view suggested settings
In docs folder create a custom js file, for example search-bar.js
. Add path to this file to the mkdocs.yml
and disable default search bar with plugins: []
:
extra_javascript:
- search-bar.js
plugins: []
Then add the search bar:
document.addEventListener("DOMContentLoaded", () => {
const inkeepDiv = document.createElement("div");
inkeepDiv.id = "inkeepSearchBar";
const headerElement = document.querySelector(".navbar-nav");
if (headerElement) {
headerElement.parentNode.insertBefore(inkeepDiv, headerElement.nextSibling);
}
const inkeepScript = document.createElement("script");
inkeepScript.src = "https://unpkg.com/@inkeep/uikit-js@0.3.18/dist/embed.js";
inkeepScript.type = "module";
inkeepScript.defer = true;
document.head.appendChild(inkeepScript);
inkeepScript.addEventListener("load", () => {
Inkeep().embed({
componentType: "SearchBar",
targetElement: "#inkeepSearchBar",
colorModeSync: {
observedElement: document.documentElement,
isDarkModeCallback: (el) => {
const currentTheme = el.getAttribute("data-md-color-scheme");
return currentTheme === "dracula" || currentTheme === "dark";
},
colorModeAttribute: "data-md-color-scheme",
},
properties: {
baseSettings: {
apiKey: "INKEEP_API_KEY",
integrationId: "INKEEP_INTEGRATION_ID",
organizationId: "INKEEP_ORGANIZATION_ID",
primaryBrandColor: "#26D6FF",
organizationDisplayName: "Inkeep",
},
},
});
});
});
For a full list of customizations, check out the Search Bar documentation.