/** * Copyright (c) Facebook, Inc. and its affiliates. * * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. */ const path = require('path'); const versions = require('./versions.json'); const math = require('remark-math'); const katex = require('rehype-katex'); const VersionsArchived = require('./versionsArchived.json'); const {dogfoodingPluginInstances} = require('./_dogfooding/dogfooding.config'); // This probably only makes sense for the beta phase, temporary function getNextBetaVersionName() { const expectedPrefix = '2.0.0-beta.'; const lastReleasedVersion = versions[0]; if (!lastReleasedVersion.includes(expectedPrefix)) { throw new Error( 'this code is only meant to be used during the 2.0 beta phase.', ); } const version = parseInt(lastReleasedVersion.replace(expectedPrefix, ''), 10); return `${expectedPrefix}${version + 1}`; } const allDocHomesPaths = [ '/docs/', '/docs/next/', ...versions.slice(1).map((version) => `/docs/${version}/`), ]; const isDev = process.env.NODE_ENV === 'development'; const isDeployPreview = process.env.NETLIFY && process.env.CONTEXT === 'deploy-preview'; const baseUrl = process.env.BASE_URL || '/'; const isBootstrapPreset = process.env.DOCUSAURUS_PRESET === 'bootstrap'; // Special deployment for staging locales until they get enough translations // https://app.netlify.com/sites/docusaurus-i18n-staging // https://docusaurus-i18n-staging.netlify.app/ const isI18nStaging = process.env.I18N_STAGING === 'true'; const isVersioningDisabled = !!process.env.DISABLE_VERSIONING || isI18nStaging; /** @type {import('@docusaurus/types').DocusaurusConfig} */ (module.exports = { title: 'Docusaurus', tagline: 'Build optimized websites quickly, focus on your content', organizationName: 'facebook', projectName: 'docusaurus', baseUrl, baseUrlIssueBanner: true, url: 'https://docusaurus.io', // Dogfood both settings: // - force trailing slashes for deploy previews // - avoid trailing slashes in prod trailingSlash: isDeployPreview, stylesheets: [ { href: 'https://cdn.jsdelivr.net/npm/katex@0.13.11/dist/katex.min.css', integrity: 'sha384-Um5gpz1odJg5Z4HAmzPtgZKdTBHZdw8S29IecapCSB31ligYPhHQZMIlWLYQGVoc', crossorigin: 'anonymous', }, ], i18n: { defaultLocale: 'en', locales: isDeployPreview ? // Deploy preview: keep it fast! ['en'] : isI18nStaging ? // Staging locales: https://docusaurus-i18n-staging.netlify.app/ ['en', 'ja'] : // Production locales ['en', 'fr', 'ko', 'zh-CN'], }, webpack: { jsLoader: (isServer) => ({ loader: require.resolve('esbuild-loader'), options: { loader: 'tsx', format: isServer ? 'cjs' : undefined, target: isServer ? 'node12' : 'es2017', }, }), }, onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', favicon: 'img/docusaurus.ico', customFields: { description: 'An optimized site generator in React. Docusaurus helps you to move fast and write content. Build documentation websites, blogs, marketing pages, and more.', }, clientModules: [require.resolve('./_dogfooding/clientModuleExample.ts')], themes: ['@docusaurus/theme-live-codeblock'], plugins: [ [ '@docusaurus/plugin-content-docs', { id: 'community', path: 'community', routeBasePath: 'community', editUrl: ({locale, versionDocsDirPath, docPath}) => { if (locale !== 'en') { return `https://crowdin.com/project/docusaurus-v2/${locale}`; } return `https://github.com/facebook/docusaurus/edit/master/website/${versionDocsDirPath}/${docPath}`; }, editCurrentVersion: true, sidebarPath: require.resolve('./sidebarsCommunity.js'), showLastUpdateAuthor: true, showLastUpdateTime: true, }, ], [ '@docusaurus/plugin-client-redirects', { fromExtensions: ['html'], createRedirects: function (path) { // redirect to /docs from /docs/introduction, // as introduction has been made the home doc if (allDocHomesPaths.includes(path)) { return [`${path}/introduction`]; } }, redirects: [ { from: ['/docs/support', '/docs/next/support'], to: '/community/support', }, { from: ['/docs/team', '/docs/next/team'], to: '/community/team', }, { from: ['/docs/resources', '/docs/next/resources'], to: '/community/resources', }, ], }, ], [ '@docusaurus/plugin-ideal-image', { quality: 70, max: 1030, // max resized image's size. min: 640, // min resized image's size. if original is lower, use that size. steps: 2, // the max number of images generated between min and max (inclusive) }, ], [ '@docusaurus/plugin-pwa', { debug: isDeployPreview, offlineModeActivationStrategies: [ 'appInstalled', 'standalone', 'queryString', ], // swRegister: false, swCustom: path.resolve(__dirname, 'src/sw.js'), pwaHead: [ { tagName: 'link', rel: 'icon', href: 'img/docusaurus.png', }, { tagName: 'link', rel: 'manifest', href: 'manifest.json', }, { tagName: 'meta', name: 'theme-color', content: 'rgb(37, 194, 160)', }, { tagName: 'meta', name: 'apple-mobile-web-app-capable', content: 'yes', }, { tagName: 'meta', name: 'apple-mobile-web-app-status-bar-style', content: '#000', }, { tagName: 'link', rel: 'apple-touch-icon', href: 'img/docusaurus.png', }, { tagName: 'link', rel: 'mask-icon', href: 'img/docusaurus.png', color: 'rgb(62, 204, 94)', }, { tagName: 'meta', name: 'msapplication-TileImage', content: 'img/docusaurus.png', }, { tagName: 'meta', name: 'msapplication-TileColor', content: '#000', }, ], }, ], ...dogfoodingPluginInstances, ], presets: [ [ isBootstrapPreset ? '@docusaurus/preset-bootstrap' : '@docusaurus/preset-classic', { debug: true, // force debug plugin usage docs: { // routeBasePath: '/', path: 'docs', sidebarPath: 'sidebars.js', // sidebarCollapsible: false, // sidebarCollapsed: true, editUrl: ({locale, docPath}) => { if (locale !== 'en') { return `https://crowdin.com/project/docusaurus-v2/${locale}`; } // We want users to submit doc updates to the upstream/next version! // Otherwise we risk losing the update on the next release. const nextVersionDocsDirPath = 'docs'; return `https://github.com/facebook/docusaurus/edit/master/website/${nextVersionDocsDirPath}/${docPath}`; }, showLastUpdateAuthor: true, showLastUpdateTime: true, remarkPlugins: [ math, [require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}], ], rehypePlugins: [katex], disableVersioning: isVersioningDisabled, lastVersion: isDev ? 'current' : undefined, onlyIncludeVersions: !isVersioningDisabled && (isDev || isDeployPreview) ? ['current', ...versions.slice(0, 2)] : undefined, versions: { current: { label: `${getNextBetaVersionName()} 🚧`, }, }, }, blog: { // routeBasePath: '/', path: 'blog', editUrl: ({locale, blogDirPath, blogPath}) => { if (locale !== 'en') { return `https://crowdin.com/project/docusaurus-v2/${locale}`; } return `https://github.com/facebook/docusaurus/edit/master/website/${blogDirPath}/${blogPath}`; }, postsPerPage: 3, feedOptions: { type: 'all', copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc.`, }, blogSidebarCount: 'ALL', blogSidebarTitle: 'All our posts', }, pages: { remarkPlugins: [require('@docusaurus/remark-plugin-npm2yarn')], }, theme: { customCss: [require.resolve('./src/css/custom.css')], }, }, ], ], themeConfig: { liveCodeBlock: { playgroundPosition: 'bottom', }, hideableSidebar: true, colorMode: { defaultMode: 'light', disableSwitch: false, respectPrefersColorScheme: true, }, announcementBar: { id: 'announcementBar-1', // Increment on change content: '⭐️ If you like Docusaurus, give it a star on GitHub! ⭐', }, prism: { theme: require('prism-react-renderer/themes/github'), darkTheme: require('prism-react-renderer/themes/dracula'), additionalLanguages: ['java'], }, image: 'img/docusaurus-soc.png', // metadatas: [{name: 'twitter:card', content: 'summary'}], gtag: !isDeployPreview ? { trackingID: 'UA-141789564-1', } : undefined, algolia: { apiKey: '47ecd3b21be71c5822571b9f59e52544', indexName: 'docusaurus-2', contextualSearch: true, }, navbar: { hideOnScroll: true, title: 'Docusaurus', logo: { alt: 'Docusaurus Logo', src: 'img/docusaurus.svg', srcDark: 'img/docusaurus_keytar.svg', }, items: [ { type: 'doc', position: 'left', docId: 'introduction', label: 'Docs', }, { type: 'doc', position: 'left', docId: 'cli', label: 'API', }, {to: 'blog', label: 'Blog', position: 'left'}, {to: 'showcase', label: 'Showcase', position: 'left'}, { to: '/community/support', label: 'Community', position: 'left', activeBaseRegex: `/community/`, }, // right { type: 'docsVersionDropdown', position: 'right', dropdownActiveClassDisabled: true, dropdownItemsAfter: [ ...Object.entries(VersionsArchived).map( ([versionName, versionUrl]) => ({ label: versionName, href: versionUrl, }), ), { href: 'https://v1.docusaurus.io', label: '1.x.x', }, { to: '/versions', label: 'All versions', }, ], }, { type: 'localeDropdown', position: 'right', dropdownItemsAfter: [ { href: 'https://github.com/facebook/docusaurus/issues/3526', label: 'Help Us Translate', }, ], }, { href: 'https://github.com/facebook/docusaurus', position: 'right', className: 'header-github-link', 'aria-label': 'GitHub repository', }, ], }, footer: { style: 'dark', links: [ { title: 'Learn', items: [ { label: 'Introduction', to: 'docs', }, { label: 'Installation', to: 'docs/installation', }, { label: 'Migration from v1 to v2', to: 'docs/migration', }, ], }, { title: 'Community', items: [ { label: 'Stack Overflow', href: 'https://stackoverflow.com/questions/tagged/docusaurus', }, { label: 'Feedback', to: 'feedback', }, { label: 'Discord', href: 'https://discordapp.com/invite/docusaurus', }, { label: 'Help', to: '/community/support', }, ], }, { title: 'More', items: [ { label: 'Blog', to: 'blog', }, { label: 'GitHub', href: 'https://github.com/facebook/docusaurus', }, { label: 'Twitter', href: 'https://twitter.com/docusaurus', }, { html: ` Deploys by Netlify `, }, ], }, { title: 'Legal', // Please do not remove the privacy and terms, it's a legal requirement. items: [ { label: 'Privacy', href: 'https://opensource.facebook.com/legal/privacy/', }, { label: 'Terms', href: 'https://opensource.facebook.com/legal/terms/', }, { label: 'Data Policy', href: 'https://opensource.facebook.com/legal/data-policy/', }, { label: 'Cookie Policy', href: 'https://opensource.facebook.com/legal/cookie-policy/', }, ], }, ], logo: { alt: 'Facebook Open Source Logo', src: 'img/oss_logo.png', href: 'https://opensource.facebook.com', }, copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc. Built with Docusaurus.`, }, }, });