diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 16a44861a..c16b8c923 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -1,46 +1,47 @@ -const lightCodeTheme = require('prism-react-renderer/themes/github'); +const lightCodeTheme = require("prism-react-renderer/themes/github"); // With JSDoc @type annotations, IDEs can provide config autocompletion /** @type {import('@docusaurus/types').DocusaurusConfig} */ ( module.exports = { - title: 'LangFlow Documentation', - tagline: 'LangFlow is a GUI for LangChain, designed with react-flow', - favicon: 'img/favicon.ico', - url: 'https://logspace-ai.github.io', - baseUrl: '/', - onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', - organizationName: 'logspace-ai', - projectName: 'langflow', + title: "LangFlow Documentation", + tagline: "LangFlow is a GUI for LangChain, designed with react-flow", + favicon: "img/favicon.ico", + url: "https://logspace-ai.github.io", + baseUrl: "/", + onBrokenLinks: "throw", + onBrokenMarkdownLinks: "warn", + organizationName: "logspace-ai", + deploymentBranch: "main", + projectName: "langflow", trailingSlash: false, customFields: { mendableAnonKey: process.env.MENDABLE_ANON_KEY, }, i18n: { - defaultLocale: 'en', - locales: ['en'], + defaultLocale: "en", + locales: ["en"], }, presets: [ [ - '@docusaurus/preset-classic', + "@docusaurus/preset-classic", /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { - routeBasePath: '/', - sidebarPath: require.resolve('./sidebars.js'), - path: 'docs', + routeBasePath: "/", + sidebarPath: require.resolve("./sidebars.js"), + path: "docs", // sidebarPath: 'sidebars.js', }, theme: { - customCss: require.resolve('./src/css/custom.css'), + customCss: require.resolve("./src/css/custom.css"), }, }), ], ], - plugins: [ - ['docusaurus-node-polyfills', { excludeAliases: ['console'] }], - 'docusaurus-plugin-image-zoom', + plugins: [ + ["docusaurus-node-polyfills", { excludeAliases: ["console"] }], + "docusaurus-plugin-image-zoom", // .... async function myPlugin(context, options) { return { @@ -59,35 +60,35 @@ const lightCodeTheme = require('prism-react-renderer/themes/github'); ({ navbar: { hideOnScroll: true, - title: 'LangFlow', + title: "LangFlow", logo: { - alt: 'LangFlow', - src: 'img/chain.png', + alt: "LangFlow", + src: "img/chain.png", }, items: [ // right { - position: 'right', - href: 'https://github.com/logspace-ai/langflow', - position: 'right', - className: 'header-github-link', - target: '_blank', + position: "right", + href: "https://github.com/logspace-ai/langflow", + position: "right", + className: "header-github-link", + target: "_blank", rel: null, }, { - position: 'right', - href: 'https://twitter.com/logspace_ai', - position: 'right', - className: 'header-twitter-link', - target: '_blank', + position: "right", + href: "https://twitter.com/logspace_ai", + position: "right", + className: "header-twitter-link", + target: "_blank", rel: null, }, { - position: 'right', - href: 'https://discord.gg/EqksyE2EX9', - position: 'right', - className: 'header-discord-link', - target: '_blank', + position: "right", + href: "https://discord.gg/EqksyE2EX9", + position: "right", + className: "header-discord-link", + target: "_blank", rel: null, }, ], @@ -97,32 +98,31 @@ const lightCodeTheme = require('prism-react-renderer/themes/github'); maxHeadingLevel: 5, }, colorMode: { - defaultMode: 'light', + defaultMode: "light", disableSwitch: true, respectPrefersColorScheme: false, }, announcementBar: { content: '⭐️ If you like ⛓️LangFlow, star it on GitHub! ⭐️', - backgroundColor: '#B53D38', //Mustard Yellow #D19900 #D4B20B - Salmon #E9967A - textColor: '#fff', + backgroundColor: "#B53D38", //Mustard Yellow #D19900 #D4B20B - Salmon #E9967A + textColor: "#fff", isCloseable: false, + }, + footer: { + links: [], + copyright: `Copyright © ${new Date().getFullYear()} Logspace.`, + }, + zoom: { + selector: ".markdown :not(a) > img:not(.no-zoom)", + background: { + light: "rgba(240, 240, 240, 0.9)", }, - footer: { - links: [ - ], - copyright: `Copyright © ${new Date().getFullYear()} Logspace.`, - }, - zoom: { - selector: '.markdown :not(a) > img:not(.no-zoom)', - background: { - light: 'rgba(240, 240, 240, 0.9)', - }, - config: {}, - }, - prism: { - theme: lightCodeTheme, - }, - }), - } - ); \ No newline at end of file + config: {}, + }, + prism: { + theme: lightCodeTheme, + }, + }), + } +); diff --git a/docs/sidebars.js b/docs/sidebars.js index 212665b61..6a0c31b68 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -1,86 +1,66 @@ module.exports = { docs: [ { - type: 'category', - label: 'Getting Started', - collapsed: false, - items: ['index', 'getting-started/installation', 'getting-started/hugging-face-spaces', 'getting-started/creating-flows'], - }, - { - type: 'category', - label: 'Guidelines', - collapsed: false, - items: ['guidelines/components', 'guidelines/features', 'guidelines/collection'], - }, - { - type: 'category', - label: 'Components', + type: "category", + label: "Getting Started", collapsed: false, items: [ - 'components/agents', 'components/chains', 'components/loaders', 'components/embeddings', 'components/llms', - 'components/memories', 'components/prompts','components/text-splitters', 'components/toolkits', 'components/tools', - 'components/utilities', 'components/vector-stores', 'components/wrappers', + "index", + "getting-started/installation", + "getting-started/hugging-face-spaces", + "getting-started/creating-flows", ], }, { - type: 'category', - label: 'Examples', + type: "category", + label: "Guidelines", collapsed: false, items: [ - 'examples/conversation-chain', 'examples/buffer-memory','examples/midjourney-prompt-chain', - 'examples/csv-loader', 'examples/serp-api-tool', 'examples/multiple-vectorstores', 'examples/python-function', - 'examples/how-upload-examples', + "guidelines/components", + "guidelines/features", + "guidelines/collection", + ], + }, + // { + // type: 'category', + // label: 'Components', + // collapsed: false, + // items: [ + // 'components/agents', 'components/chains', 'components/loaders', 'components/embeddings', 'components/llms', + // 'components/memories', 'components/prompts','components/text-splitters', 'components/toolkits', 'components/tools', + // 'components/utilities', 'components/vector-stores', 'components/wrappers', + // ], + // }, + { + type: "category", + label: "Examples", + collapsed: false, + items: [ + "examples/conversation-chain", + "examples/buffer-memory", + "examples/midjourney-prompt-chain", + "examples/csv-loader", + "examples/serp-api-tool", + "examples/multiple-vectorstores", + "examples/python-function", + "examples/how-upload-examples", ], }, { - type: 'category', - label: 'Deployment', + type: "category", + label: "Deployment", collapsed: false, - items: ['deployment/gcp-deployment', 'deployment/jina-deployment'], + items: ["deployment/gcp-deployment", "deployment/jina-deployment"], }, { - type: 'category', - label: 'Contributing', + type: "category", + label: "Contributing", collapsed: false, - items: ['contributing/how-contribute', 'contributing/github-issues', 'contributing/community'], + items: [ + "contributing/how-contribute", + "contributing/github-issues", + "contributing/community", + ], }, ], }; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -