306 lines
8.7 KiB
JavaScript
306 lines
8.7 KiB
JavaScript
/**
|
||
* 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');
|
||
|
||
// read this text file
|
||
const fs = require('fs');
|
||
const versions = fs.readFileSync('../../version.txt', 'utf8').split('\n');
|
||
|
||
const ArchivedVersionsDropdownItems = [
|
||
{
|
||
version: '3.8.5',
|
||
href: 'https://v3p8.docs.ohif.org',
|
||
isExternal: true,
|
||
},
|
||
{
|
||
version: '2.0',
|
||
href: 'https://v2.docs.ohif.org',
|
||
isExternal: true,
|
||
},
|
||
{
|
||
version: '1.0',
|
||
href: 'https://v1.docs.ohif.org',
|
||
isExternal: true,
|
||
},
|
||
];
|
||
|
||
const baseUrl = process.env.BASE_URL || '/';
|
||
|
||
/** @type {import('@docusaurus/types').DocusaurusConfig} */
|
||
module.exports = {
|
||
future: {
|
||
experimental_faster: true,
|
||
},
|
||
title: 'OHIF',
|
||
tagline: 'Open-source web-based medical imaging platform',
|
||
organizationName: 'Open Health Imaging Foundation',
|
||
projectName: 'OHIF',
|
||
baseUrl,
|
||
baseUrlIssueBanner: true,
|
||
url: 'https://docs.ohif.org',
|
||
i18n: {
|
||
defaultLocale: 'en',
|
||
locales: ['en'],
|
||
},
|
||
onBrokenLinks: 'throw',
|
||
onBrokenMarkdownLinks: 'throw',
|
||
favicon: 'img/favicon.ico',
|
||
themes: ['@docusaurus/theme-live-codeblock'],
|
||
plugins: [
|
||
// path.resolve(__dirname, './pluginOHIFWebpackConfig.js'),
|
||
// /path.resolve(__dirname, './postcss.js'),
|
||
'docusaurus-plugin-image-zoom', // 3rd party plugin for image click to pop
|
||
[
|
||
'@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)
|
||
},
|
||
],
|
||
],
|
||
presets: [
|
||
[
|
||
'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.
|
||
return `https://github.com/OHIF/Viewers/edit/master/platform/docs/docs/${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: `${versions} (Latest)`,
|
||
},
|
||
},
|
||
},
|
||
theme: {
|
||
customCss: [require.resolve('./src/css/custom.css')],
|
||
},
|
||
gtag: {
|
||
trackingID: 'G-DDBJFE34EG',
|
||
anonymizeIP: true,
|
||
},
|
||
},
|
||
],
|
||
],
|
||
themeConfig:
|
||
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||
({
|
||
liveCodeBlock: {
|
||
playgroundPosition: 'bottom',
|
||
},
|
||
docs: {
|
||
sidebar: {
|
||
hideable: true,
|
||
autoCollapseCategories: true,
|
||
},
|
||
},
|
||
colorMode: {
|
||
defaultMode: 'dark',
|
||
disableSwitch: false,
|
||
// respectPrefersColorScheme: true,
|
||
},
|
||
announcementBar: {
|
||
id: 'cornerstone20_ohif_anniversary',
|
||
content:
|
||
'🎉 Celebrating OHIF’s 10-Year Anniversary with Cornerstone 2.0! Explore enhanced segmentation, new video & microscopy viewports, UI/UX upgrades, and blazing fast prefetching. Dive into the release notes <a target="_blank" rel="noopener noreferrer" href="https://ohif.org/release-notes/3p9/">here</a>! 🚀',
|
||
},
|
||
|
||
prism: {
|
||
theme: require('prism-react-renderer').themes.github,
|
||
darkTheme: require('prism-react-renderer').themes.dracula,
|
||
},
|
||
algolia: {
|
||
appId: 'EFLT6YIHHZ',
|
||
apiKey: 'c220dd24fe4f86248eea3b1238a1fb60',
|
||
indexName: 'ohif',
|
||
},
|
||
navbar: {
|
||
hideOnScroll: false,
|
||
logo: {
|
||
alt: 'OHIF Logo',
|
||
src: 'img/ohif-logo-light.svg',
|
||
srcDark: 'img/ohif-logo.svg',
|
||
},
|
||
items: [
|
||
{
|
||
position: 'left',
|
||
to: '/',
|
||
activeBaseRegex: '^(/next/|/)$',
|
||
docId: 'Introduction',
|
||
label: 'Docs',
|
||
},
|
||
{
|
||
to: '/components',
|
||
label: 'Components',
|
||
position: 'left',
|
||
},
|
||
{
|
||
href: 'https://ohif.org/showcase',
|
||
label: 'Showcase',
|
||
target: '_blank',
|
||
position: 'left',
|
||
},
|
||
{
|
||
href: 'https://ohif.org/collaborate',
|
||
label: 'Collaborate',
|
||
target: '_blank',
|
||
position: 'left',
|
||
},
|
||
{
|
||
to: '/help',
|
||
//activeBaseRegex: '(^/help$)|(/help)',
|
||
label: 'Help',
|
||
position: 'left',
|
||
},
|
||
{
|
||
to: '/migration-guide/3p8-to-3p9/',
|
||
//activeBaseRegex: '(^/help$)|(/help)',
|
||
label: '3.9 Migration Guides',
|
||
position: 'left',
|
||
},
|
||
{
|
||
type: 'docsVersionDropdown',
|
||
position: 'right',
|
||
dropdownActiveClassDisabled: true,
|
||
dropdownItemsAfter: [
|
||
{
|
||
type: 'html',
|
||
value: '<hr class="dropdown-separator">',
|
||
},
|
||
{
|
||
type: 'html',
|
||
className: 'dropdown-archived-versions',
|
||
value: '<b>Archived versions</b>',
|
||
},
|
||
...ArchivedVersionsDropdownItems.map(item => ({
|
||
label: `${item.version} `,
|
||
href: item.href,
|
||
target: item.isExternal ? '_blank' : undefined,
|
||
rel: item.isExternal ? 'noopener noreferrer' : undefined,
|
||
})),
|
||
],
|
||
},
|
||
{
|
||
type: 'localeDropdown',
|
||
position: 'right',
|
||
dropdownItemsAfter: [
|
||
{
|
||
to: '/platform/internationalization',
|
||
label: 'Help Us Translate',
|
||
},
|
||
],
|
||
},
|
||
{
|
||
to: 'https://github.com/OHIF/Viewers',
|
||
position: 'right',
|
||
className: 'header-github-link',
|
||
'aria-label': 'GitHub Repository',
|
||
},
|
||
],
|
||
},
|
||
footer: {
|
||
style: 'dark',
|
||
links: [
|
||
{
|
||
title: ' ',
|
||
items: [
|
||
{
|
||
// This doesn't show up on dev for some reason, but displays in build
|
||
html: `
|
||
<a href="https://www.massgeneral.org/" target="_blank" rel="noreferrer noopener">
|
||
<img src="/img/mgh-logo.png" id="mgh-logo" alt="MGH" />
|
||
</a>
|
||
`,
|
||
},
|
||
],
|
||
},
|
||
{
|
||
title: 'Learn',
|
||
items: [
|
||
{
|
||
label: 'Introduction',
|
||
to: '/',
|
||
},
|
||
{
|
||
label: 'Getting Started',
|
||
to: 'development/getting-started',
|
||
},
|
||
{
|
||
label: 'FAQ',
|
||
to: '/faq',
|
||
},
|
||
{
|
||
label: 'Resources',
|
||
to: '/resources',
|
||
},
|
||
],
|
||
},
|
||
{
|
||
title: 'Community',
|
||
items: [
|
||
{
|
||
label: 'Discussion board',
|
||
href: 'https://community.ohif.org/',
|
||
},
|
||
{
|
||
label: 'Help',
|
||
to: '/help',
|
||
},
|
||
],
|
||
},
|
||
{
|
||
title: 'More',
|
||
items: [
|
||
{
|
||
label: 'Donate',
|
||
href: 'https://giving.massgeneral.org/ohif',
|
||
},
|
||
{
|
||
label: 'GitHub',
|
||
href: 'https://github.com/OHIF/Viewers',
|
||
},
|
||
{
|
||
label: 'Twitter',
|
||
href: 'https://twitter.com/OHIFviewer',
|
||
},
|
||
],
|
||
},
|
||
],
|
||
logo: {
|
||
alt: 'OHIF ',
|
||
src: 'img/netlify-color-accent.svg',
|
||
href: 'https://viewer.ohif.org/',
|
||
},
|
||
copyright: `OHIF is open source software released under the MIT license.`,
|
||
},
|
||
}),
|
||
};
|