docs: Improve the search UX in Langflow docs (#4089)
* Add Mendable search bar component * Align Mendable anon_key retrieval * Update url and tagline in docusaurus config * Move sitemap config to preset options * Add Mendable anon key to docusaurus config
This commit is contained in:
parent
6aa34dac65
commit
2835f66aec
3 changed files with 30 additions and 11 deletions
|
|
@ -8,9 +8,9 @@ const { remarkCodeHike } = require("@code-hike/mdx");
|
||||||
/** @type {import('@docusaurus/types').Config} */
|
/** @type {import('@docusaurus/types').Config} */
|
||||||
const config = {
|
const config = {
|
||||||
title: "Langflow Documentation",
|
title: "Langflow Documentation",
|
||||||
tagline: "Langflow is a GUI for LangChain, designed with react-flow",
|
tagline: "Langflow is a low-code app builder for RAG and multi-agent AI applications.",
|
||||||
favicon: "img/favicon.ico",
|
favicon: "img/favicon.ico",
|
||||||
url: "https://langflow-ai.github.io",
|
url: "https://docs.langflow.org",
|
||||||
baseUrl: "/",
|
baseUrl: "/",
|
||||||
onBrokenLinks: "throw",
|
onBrokenLinks: "throw",
|
||||||
onBrokenMarkdownLinks: "warn",
|
onBrokenMarkdownLinks: "warn",
|
||||||
|
|
@ -19,7 +19,7 @@ const config = {
|
||||||
trailingSlash: false,
|
trailingSlash: false,
|
||||||
staticDirectories: ["static"],
|
staticDirectories: ["static"],
|
||||||
customFields: {
|
customFields: {
|
||||||
mendableAnonKey: process.env.MENDABLE_ANON_KEY,
|
mendableAnonKey: "b7f52734-297c-41dc-8737-edbd13196394", // Mendable Anon Client-side key, safe to expose to the public
|
||||||
},
|
},
|
||||||
i18n: {
|
i18n: {
|
||||||
defaultLocale: "en",
|
defaultLocale: "en",
|
||||||
|
|
@ -46,6 +46,13 @@ const config = {
|
||||||
],
|
],
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
|
sitemap: {
|
||||||
|
// https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-sitemap
|
||||||
|
// https://developers.google.com/search/docs/crawling-indexing/sitemaps/build-sitemap
|
||||||
|
lastmod: 'datetime',
|
||||||
|
changefreq: null,
|
||||||
|
priority: null,
|
||||||
|
},
|
||||||
gtag: {
|
gtag: {
|
||||||
trackingID: "G-XHC7G628ZP",
|
trackingID: "G-XHC7G628ZP",
|
||||||
anonymizeIP: true,
|
anonymizeIP: true,
|
||||||
|
|
@ -87,12 +94,6 @@ const config = {
|
||||||
themeConfig:
|
themeConfig:
|
||||||
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||||
({
|
({
|
||||||
sitemap: {
|
|
||||||
// https://www.sitemaps.org/protocol.html#xmlTagDefinitions
|
|
||||||
changefreq: "weekly",
|
|
||||||
priority: 0.5,
|
|
||||||
ignorePatterns: [],
|
|
||||||
},
|
|
||||||
navbar: {
|
navbar: {
|
||||||
hideOnScroll: true,
|
hideOnScroll: true,
|
||||||
title: "Langflow",
|
title: "Langflow",
|
||||||
|
|
|
||||||
|
|
@ -37,7 +37,7 @@ export default function FooterWrapper(props) {
|
||||||
|
|
||||||
const mendableFloatingButton = React.createElement(MendableFloatingButton, {
|
const mendableFloatingButton = React.createElement(MendableFloatingButton, {
|
||||||
floatingButtonStyle: { color: "#000000", backgroundColor: "#f6f6f6" },
|
floatingButtonStyle: { color: "#000000", backgroundColor: "#f6f6f6" },
|
||||||
anon_key: 'b7f52734-297c-41dc-8737-edbd13196394', // Mendable Search Public ANON key, ok to be public
|
anon_key: customFields.mendableAnonKey,
|
||||||
showSimpleSearch: true,
|
showSimpleSearch: true,
|
||||||
icon: icon,
|
icon: icon,
|
||||||
});
|
});
|
||||||
|
|
|
||||||
|
|
@ -2,4 +2,22 @@
|
||||||
// If you swizzled this, it is your responsibility to provide an implementation
|
// If you swizzled this, it is your responsibility to provide an implementation
|
||||||
// Tip: swizzle the SearchBar from the Algolia theme for inspiration:
|
// Tip: swizzle the SearchBar from the Algolia theme for inspiration:
|
||||||
// npm run swizzle @docusaurus/theme-search-algolia SearchBar
|
// npm run swizzle @docusaurus/theme-search-algolia SearchBar
|
||||||
export {default} from '@docusaurus/Noop';
|
import React from 'react'
|
||||||
|
import { MendableSearchBar } from '@mendable/search'
|
||||||
|
import useDocusaurusContext from '@docusaurus/useDocusaurusContext'
|
||||||
|
|
||||||
|
export default function SearchBarWrapper() {
|
||||||
|
const {
|
||||||
|
siteConfig: { customFields },
|
||||||
|
} = useDocusaurusContext()
|
||||||
|
return (
|
||||||
|
<div className="mendable-search">
|
||||||
|
<MendableSearchBar
|
||||||
|
anon_key={customFields.mendableAnonKey}
|
||||||
|
placeholder="Search..."
|
||||||
|
dialogPlaceholder="How to deploy my application?"
|
||||||
|
showSimpleSearch
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue