ToolJet/docs/docusaurus.config.js

227 lines
7.7 KiB
JavaScript
Raw Normal View History

const devServerPlugin = require('./src/plugins/devServer/index.js');
import versionsArchived from './versionsArchived.json';
const baseArchivedURL = "https://archived-docs.tooljet.com/docs/";
const lastFiveArchivedVersions = versionsArchived
.slice(0, 5)
.map((version, index) => ({
version,
url: index === 0 ? baseArchivedURL : `${baseArchivedURL}${version}`
}));
const isProd = process.env.NODE_ENV === 'production';
2021-04-23 12:54:49 +00:00
/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
2022-12-26 06:47:29 +00:00
title: 'ToolJet',
2021-11-18 14:56:39 +00:00
tagline: 'Low-code framework to Build internal tools and business apps.',
2025-02-12 12:01:53 +00:00
url: 'https://docs.tooljet.ai',
2021-04-23 12:54:49 +00:00
baseUrl: '/',
onBrokenLinks: 'ignore',
2021-04-23 12:54:49 +00:00
onBrokenMarkdownLinks: 'warn',
favicon: 'img/tooljet-ai-favicon.svg',
organizationName: 'ToolJet', // Usually your GitHub org/user name.
projectName: 'ToolJet', // Usually your repo name.
2021-04-23 12:54:49 +00:00
themeConfig: {
2025-02-12 12:01:53 +00:00
image: 'img/tooljet-ai-og-image.png',
announcementBar: {
id: 'support_us',
content:
'Star our repository on <a target="_blank" rel="noopener noreferrer" href="https://github.com/ToolJet/ToolJet">GitHub</a> to stay updated with new features and contribute to our platform!',
backgroundColor: '#ECF0FE',
textColor: '#4368E3',
isCloseable: true,
},
2022-12-09 10:19:55 +00:00
docs: {
sidebar: {
hideable: true,
autoCollapseCategories: true
}
},
colorMode: {
},
2021-04-23 12:54:49 +00:00
navbar: {
logo: {
2024-07-16 12:03:00 +00:00
href: '/docs/',
alt: 'ToolJet Logo',
src: 'img/docs_logo.svg',
2025-02-27 06:57:17 +00:00
srcDark: `img/docs_logo_dark.svg`,
width: 120
2021-04-23 12:54:49 +00:00
},
items: [
2022-12-09 10:19:55 +00:00
{
2024-08-29 15:20:51 +00:00
type: 'docsVersionDropdown',
2022-12-09 10:19:55 +00:00
position: 'right',
},
{
type: 'search',
position: 'left',
},
2021-04-23 12:54:49 +00:00
{
href: 'https://github.com/ToolJet/ToolJet',
2021-04-23 12:54:49 +00:00
position: 'right',
className: 'navbar-social-link navbar-github-logo',
'aria-label': 'GitHub repository',
2021-04-23 12:54:49 +00:00
},
{
2025-02-12 12:01:53 +00:00
href: 'https://tooljet.ai/slack',
position: 'right',
className: 'navbar-social-link navbar-slack-logo',
'aria-label': 'Slack workspace',
},
{
href: 'https://twitter.com/ToolJet',
position: 'right',
className: 'navbar-social-link navbar-twitter-logo',
'aria-label': 'Twitter account',
},
{
href: 'https://app.tooljet.ai',
position: 'right',
label: 'Sign in',
className: 'navbar-signin',
'aria-label': 'Signin to ToolJet',
},
{
href: 'https://tooljet.ai',
position: 'right',
label: 'Website',
className: 'navbar-website',
'aria-label': 'ToolJet website',
},
2021-04-23 12:54:49 +00:00
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
},
{
title: 'Community',
items: [
{
label: 'Slack',
2025-02-12 12:01:53 +00:00
href: 'https://tooljet.ai/slack',
2021-04-23 12:54:49 +00:00
},
],
},
{
title: 'More',
items: [
{
label: 'GitHub',
2021-04-29 05:51:06 +00:00
href: 'https://github.com/ToolJet/ToolJet',
2021-04-23 12:54:49 +00:00
},
{
label: 'YouTube',
href: 'https://www.youtube.com/channel/UCf1p2G5Z7fPpvlBPf4l2I1w',
},
{
label: 'Twitter',
href: 'https://twitter.com/ToolJet',
},
2021-04-23 12:54:49 +00:00
],
},
],
2023-12-21 05:43:07 +00:00
copyright: `Copyright © ${new Date().getFullYear()} ToolJet Solutions, Inc.
2025-02-27 06:17:03 +00:00
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=4f00afac-ae1f-4cf6-8c53-8a2c7b3ca206" />
2025-03-12 06:31:24 +00:00
<script>window.faitracker=window.faitracker||function(){this.q=[];var t=new CustomEvent("FAITRACKER_QUEUED_EVENT");return this.init=function(t,e,a){this.TOKEN=t,this.INIT_PARAMS=e,this.INIT_CALLBACK=a,window.dispatchEvent(new CustomEvent("FAITRACKER_INIT_EVENT"))},this.call=function(){var e={k:"",a:[]};if(arguments&&arguments.length>=1){for(var a=1;a<arguments.length;a++)e.a.push(arguments[a]);e.k=arguments[0]}this.q.push(e),window.dispatchEvent(t)},this.message=function(){window.addEventListener("message",function(t){"faitracker"===t.data.origin&&this.call("message",t.data.type,t.data.message)})},this.message(),this.init("c4rgfujgx6jef4722rcjfhj7dlmcipih",{host:"https://api.factors.ai"}),this}(),function(){var t=document.createElement("script");t.type="text/javascript",t.src="https://app.factors.ai/assets/factors.js",t.async=!0,(d=document.getElementsByTagName("script")[0]).parentNode.insertBefore(t,d)}();</script>
2025-03-20 09:22:12 +00:00
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);})(window,document,'script','dataLayer','GTM-5L8R522S');</script>
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-5L8R522S" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
`,
2021-04-23 12:54:49 +00:00
},
algolia: {
appId: 'O8HQRLI0WA',
apiKey: process.env.ALGOLIA_API_KEY || 'development', // Public API key: it is safe to commit it
indexName: 'tooljet',
contextualSearch: true,
externalUrlRegex: 'external\\.com|domain\\.com',
},
2021-04-23 12:54:49 +00:00
},
presets: [
[
'@docusaurus/preset-classic',
{
docs: {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
2023-01-03 06:35:22 +00:00
editUrl: 'https://github.com/ToolJet/Tooljet/blob/develop/docs/',
includeCurrentVersion: true,
2024-11-10 22:27:25 +00:00
lastVersion: '3.0.0-LTS',
2024-06-26 10:27:13 +00:00
versions: {
current: {
2024-11-10 22:27:25 +00:00
label: '3.1.0-Beta 🚧',
path: 'beta',
banner: 'none',
badge: false
},
2024-11-10 22:27:25 +00:00
"2.50.0-LTS": {
banner: 'none',
badge: false
},
"3.0.0-LTS": {
banner: 'none',
badge: false
2024-11-10 22:27:25 +00:00
}
2024-06-26 10:27:13 +00:00
}
2021-04-23 12:54:49 +00:00
},
theme: {
customCss: require.resolve('./src/css/custom.css'),
},
sitemap: {
2024-01-09 08:54:23 +00:00
changefreq: 'weekly',
priority: 0.5,
ignorePatterns: ['/docs/1.x.x/**'],
filename: 'sitemap.xml',
},
2023-10-25 22:12:05 +00:00
googleTagManager: isProd
? {
containerId: process.env.GTM || 'development',
2022-12-26 06:47:29 +00:00
}
: undefined,
2021-04-23 12:54:49 +00:00
},
],
],
plugins: [
devServerPlugin,
2024-07-16 12:03:00 +00:00
'plugin-image-zoom',
[
'@docusaurus/plugin-client-redirects',
{
redirects: [
{
to: '/docs/',
from: '/',
},
{
to: '/docs/security/constants/',
from: '/docs/org-management/workspaces/workspace_constants/',
},
{
to: '/docs/development-lifecycle/gitsync/overview',
from: '/docs/gitsync',
},
{
to: '/docs/user-management/role-based-access/access-control',
from: '/docs/tutorial/manage-users-groups',
},
{
to: '/docs/security/constants/variables/',
from: '/docs/org-management/workspaces/workspace-variables-migration',
},
{
to: '/docs/tj-setup/smtp-setup/configuration',
from: '/docs/org-management/smtp-configuration/',
},
{
to: '/docs/user-management/authentication/self-hosted/instance-login/',
from: '/docs/enterprise/superadmin',
}
2024-07-16 12:03:00 +00:00
],
},
],
],
2024-07-16 12:03:00 +00:00
};