/** * 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'); // This probably only makes sense for the beta phase, temporary function getNextBetaVersionName() { const expectedPrefix = ''; 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 || '/docs/'; 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: 'OHIF', tagline: 'Build optimized websites quickly, focus on your content', organizationName: 'facebook', projectName: 'OHIF', baseUrl, baseUrlIssueBanner: true, url: 'https://ohif.org', 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'], }, onBrokenLinks: 'warn', 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.', // }, themes: ['@docusaurus/theme-live-codeblock'], plugins: [ [ '@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: ['/'], // to: '/docs', // }, // { // 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: `${baseUrl}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.svg', color: 'rgb(62, 204, 94)', }, { tagName: 'meta', name: 'msapplication-TileImage', content: 'img/docusaurus.png', }, { tagName: 'meta', name: 'msapplication-TileColor', content: '#000', }, ], }, ], ], presets: [ [ isBootstrapPreset ? '@docusaurus/preset-bootstrap' : '@docusaurus/preset-classic', { debug: true, // force debug plugin usage docs: { routeBasePath: '/', path: 'docs', sidebarPath: require.resolve('./sidebars.js'), 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/OHIF/Viewers/edit/master/website/${nextVersionDocsDirPath}/${docPath}`; }, showLastUpdateAuthor: true, showLastUpdateTime: true, // remarkPlugins: [ // [require('@docusaurus/remark-plugin-npm2yarn'), { sync: true }], // ], // disableVersioning: isVersioningDisabled, // lastVersion: 'current', // onlyIncludeVersions: // !isVersioningDisabled && (isDev || isDeployPreview) // ? ['current', ...versions.slice(0, 2)] // : undefined, // versions: { // current: { // // label: `${getNextBetaVersionName()} 🚧`, // // label: `2.0 🎉`, // label: `2.0`, // // path: `2.0`, // }, // }, }, theme: { customCss: [require.resolve('./src/css/custom.css')], }, }, ], ], themeConfig: { liveCodeBlock: { playgroundPosition: 'bottom', }, hideableSidebar: true, colorMode: { defaultMode: 'light', disableSwitch: false, respectPrefersColorScheme: true, }, // announcementBar: { // id: 'v1-new-domain', // content: // '➡️ Docusaurus v1 documentation has moved to v1.docusaurus.io! 🔄', // }, /* announcementBar: { id: 'supportus', 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'), }, image: 'img/docusaurus-soc.png', // metadatas: [{name: 'twitter:card', content: 'summary'}], gtag: { trackingID: 'UA-110573590-2', }, algolia: { apiKey: '47ecd3b21be71c5822571b9f59e52544', indexName: 'docusaurus-2', contextualSearch: true, }, navbar: { hideOnScroll: true, logo: { alt: 'OHIF Logo', src: 'img/logo-ohif.svg', srcDark: 'img/logo-ohif.svg', }, items: [ { type: 'doc', position: 'left', docId: 'Introduction', label: 'Docs', }, // {to: 'blog', label: 'Blog', position: 'left'}, // {to: 'showcase', label: 'Showcase', position: 'left'}, // right { type: 'docsVersionDropdown', position: 'right', dropdownActiveClassDisabled: true, }, { type: 'localeDropdown', position: 'right', dropdownItemsAfter: [ { to: 'https://github.com/OHIF/Viewers/issues/3526', label: 'Help Us Translate', }, ], }, { href: 'https://github.com/OHIF/Viewers', 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/OHIF/Viewers', // }, // { // 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: 'OHIF ', src: 'img/ohif.svg', href: 'https://ohif.org', }, copyright: `Copyright © OHIF`, }, }, });