🔧 chore(docusaurus.config.js): format code and fix linting issues

🔧 chore(sidebars.js): format code and fix indentation
This commit is contained in:
Gabriel Luiz Freitas Almeida 2023-07-12 18:04:23 -03:00
commit 803914bf07
2 changed files with 105 additions and 125 deletions

View file

@ -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 // With JSDoc @type annotations, IDEs can provide config autocompletion
/** @type {import('@docusaurus/types').DocusaurusConfig} */ /** @type {import('@docusaurus/types').DocusaurusConfig} */
( (
module.exports = { module.exports = {
title: 'LangFlow Documentation', title: "LangFlow Documentation",
tagline: 'LangFlow is a GUI for LangChain, designed with react-flow', tagline: "LangFlow is a GUI for LangChain, designed with react-flow",
favicon: 'img/favicon.ico', favicon: "img/favicon.ico",
url: 'https://logspace-ai.github.io', url: "https://logspace-ai.github.io",
baseUrl: '/', baseUrl: "/",
onBrokenLinks: 'throw', onBrokenLinks: "throw",
onBrokenMarkdownLinks: 'warn', onBrokenMarkdownLinks: "warn",
organizationName: 'logspace-ai', organizationName: "logspace-ai",
projectName: 'langflow', deploymentBranch: "main",
projectName: "langflow",
trailingSlash: false, trailingSlash: false,
customFields: { customFields: {
mendableAnonKey: process.env.MENDABLE_ANON_KEY, mendableAnonKey: process.env.MENDABLE_ANON_KEY,
}, },
i18n: { i18n: {
defaultLocale: 'en', defaultLocale: "en",
locales: ['en'], locales: ["en"],
}, },
presets: [ presets: [
[ [
'@docusaurus/preset-classic', "@docusaurus/preset-classic",
/** @type {import('@docusaurus/preset-classic').Options} */ /** @type {import('@docusaurus/preset-classic').Options} */
({ ({
docs: { docs: {
routeBasePath: '/', routeBasePath: "/",
sidebarPath: require.resolve('./sidebars.js'), sidebarPath: require.resolve("./sidebars.js"),
path: 'docs', path: "docs",
// sidebarPath: 'sidebars.js', // sidebarPath: 'sidebars.js',
}, },
theme: { theme: {
customCss: require.resolve('./src/css/custom.css'), customCss: require.resolve("./src/css/custom.css"),
}, },
}), }),
], ],
], ],
plugins: [ plugins: [
['docusaurus-node-polyfills', { excludeAliases: ['console'] }], ["docusaurus-node-polyfills", { excludeAliases: ["console"] }],
'docusaurus-plugin-image-zoom', "docusaurus-plugin-image-zoom",
// .... // ....
async function myPlugin(context, options) { async function myPlugin(context, options) {
return { return {
@ -59,35 +60,35 @@ const lightCodeTheme = require('prism-react-renderer/themes/github');
({ ({
navbar: { navbar: {
hideOnScroll: true, hideOnScroll: true,
title: 'LangFlow', title: "LangFlow",
logo: { logo: {
alt: 'LangFlow', alt: "LangFlow",
src: 'img/chain.png', src: "img/chain.png",
}, },
items: [ items: [
// right // right
{ {
position: 'right', position: "right",
href: 'https://github.com/logspace-ai/langflow', href: "https://github.com/logspace-ai/langflow",
position: 'right', position: "right",
className: 'header-github-link', className: "header-github-link",
target: '_blank', target: "_blank",
rel: null, rel: null,
}, },
{ {
position: 'right', position: "right",
href: 'https://twitter.com/logspace_ai', href: "https://twitter.com/logspace_ai",
position: 'right', position: "right",
className: 'header-twitter-link', className: "header-twitter-link",
target: '_blank', target: "_blank",
rel: null, rel: null,
}, },
{ {
position: 'right', position: "right",
href: 'https://discord.gg/EqksyE2EX9', href: "https://discord.gg/EqksyE2EX9",
position: 'right', position: "right",
className: 'header-discord-link', className: "header-discord-link",
target: '_blank', target: "_blank",
rel: null, rel: null,
}, },
], ],
@ -97,26 +98,25 @@ const lightCodeTheme = require('prism-react-renderer/themes/github');
maxHeadingLevel: 5, maxHeadingLevel: 5,
}, },
colorMode: { colorMode: {
defaultMode: 'light', defaultMode: "light",
disableSwitch: true, disableSwitch: true,
respectPrefersColorScheme: false, respectPrefersColorScheme: false,
}, },
announcementBar: { announcementBar: {
content: content:
'⭐️ If you like ⛓️LangFlow, star it on <a target="_blank" rel="noopener noreferrer" href="https://github.com/logspace-ai/langflow">GitHub</a>! ⭐️', '⭐️ If you like ⛓️LangFlow, star it on <a target="_blank" rel="noopener noreferrer" href="https://github.com/logspace-ai/langflow">GitHub</a>! ⭐️',
backgroundColor: '#B53D38', //Mustard Yellow #D19900 #D4B20B - Salmon #E9967A backgroundColor: "#B53D38", //Mustard Yellow #D19900 #D4B20B - Salmon #E9967A
textColor: '#fff', textColor: "#fff",
isCloseable: false, isCloseable: false,
}, },
footer: { footer: {
links: [ links: [],
],
copyright: `Copyright © ${new Date().getFullYear()} Logspace.`, copyright: `Copyright © ${new Date().getFullYear()} Logspace.`,
}, },
zoom: { zoom: {
selector: '.markdown :not(a) > img:not(.no-zoom)', selector: ".markdown :not(a) > img:not(.no-zoom)",
background: { background: {
light: 'rgba(240, 240, 240, 0.9)', light: "rgba(240, 240, 240, 0.9)",
}, },
config: {}, config: {},
}, },
@ -125,4 +125,4 @@ const lightCodeTheme = require('prism-react-renderer/themes/github');
}, },
}), }),
} }
); );

View file

@ -1,86 +1,66 @@
module.exports = { module.exports = {
docs: [ docs: [
{ {
type: 'category', type: "category",
label: 'Getting Started', 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',
collapsed: false, collapsed: false,
items: [ items: [
'components/agents', 'components/chains', 'components/loaders', 'components/embeddings', 'components/llms', "index",
'components/memories', 'components/prompts','components/text-splitters', 'components/toolkits', 'components/tools', "getting-started/installation",
'components/utilities', 'components/vector-stores', 'components/wrappers', "getting-started/hugging-face-spaces",
"getting-started/creating-flows",
], ],
}, },
{ {
type: 'category', type: "category",
label: 'Examples', label: "Guidelines",
collapsed: false, collapsed: false,
items: [ items: [
'examples/conversation-chain', 'examples/buffer-memory','examples/midjourney-prompt-chain', "guidelines/components",
'examples/csv-loader', 'examples/serp-api-tool', 'examples/multiple-vectorstores', 'examples/python-function', "guidelines/features",
'examples/how-upload-examples', "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', type: "category",
label: 'Deployment', label: "Deployment",
collapsed: false, collapsed: false,
items: ['deployment/gcp-deployment', 'deployment/jina-deployment'], items: ["deployment/gcp-deployment", "deployment/jina-deployment"],
}, },
{ {
type: 'category', type: "category",
label: 'Contributing', label: "Contributing",
collapsed: false, collapsed: false,
items: ['contributing/how-contribute', 'contributing/github-issues', 'contributing/community'], items: [
"contributing/how-contribute",
"contributing/github-issues",
"contributing/community",
],
}, },
], ],
}; };