Diffusion-MRI-Preprocessing/docusaurus.config.ts at main · DiffusionTensorImaging-Repos/Diffusion-MRI-Preprocessing · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
import remarkMath from 'remark-math';
import rehypeKatex from 'rehype-katex';

const config: Config = {
  title: 'Diffusion MRI Preprocessing',
  tagline: 'Preprocessing diffusion MRI data for tractography',
  favicon: 'img/favicon.ico',

  future: {
    v4: true,
  },

  url: 'https://diffusiontensorimaging-repos.github.io',
  baseUrl: '/Diffusion-MRI-Preprocessing/',

  organizationName: 'DiffusionTensorImaging-Repos',
  projectName: 'Diffusion-MRI-Preprocessing',

  onBrokenLinks: 'warn',
  onBrokenMarkdownLinks: 'warn',

  i18n: {
    defaultLocale: 'en',
    locales: ['en'],
  },

  markdown: {
    mermaid: true,
  },

  themes: ['@docusaurus/theme-mermaid'],

  stylesheets: [
    {
      href: 'https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css',
      type: 'text/css',
      integrity: 'sha384-nB0miv6/jRmo5UMMR1wu3Gz6NLsoTkbqJghGIsx//Rlm+ZU03BU6SQNC66uf4l5+',
      crossorigin: 'anonymous',
    },
  ],

  presets: [
    [
      'classic',
      {
        docs: {
          sidebarPath: './sidebars.ts',
          editUrl: 'https://github.com/DiffusionTensorImaging-Repos/Diffusion-MRI-Preprocessing/tree/main/',
          remarkPlugins: [remarkMath],
          rehypePlugins: [rehypeKatex],
        },
        blog: false,
        theme: {
          customCss: './src/css/custom.css',
        },
      } satisfies Preset.Options,
    ],
  ],

  themeConfig: {
    image: 'img/social-card.jpg',
    colorMode: {
      defaultMode: 'light',
      respectPrefersColorScheme: true,
    },
    navbar: {
      title: 'Diffusion MRI Preprocessing',
      logo: {
        alt: 'Diffusion MRI Preprocessing',
        src: 'img/logo.png',
      },
      items: [
        {
          type: 'docSidebar',
          sidebarId: 'tutorialSidebar',
          position: 'left',
          label: 'Tutorial',
        },
        {
          to: '/docs/tools/overview',
          label: 'Tools',
          position: 'left',
        },
        {
          href: 'https://github.com/DiffusionTensorImaging-Repos/SDN-IMPACT-DTI',
          label: 'Worked Example',
          position: 'right',
        },
        {
          href: 'https://github.com/DiffusionTensorImaging-Repos/Diffusion-MRI-Preprocessing',
          label: 'GitHub',
          position: 'right',
        },
      ],
    },
    footer: {
      style: 'dark',
      links: [
        {
          title: 'Tutorial',
          items: [
            {label: 'Getting Started', to: '/docs/intro'},
            {label: 'Pipeline Overview', to: '/docs/pipeline/overview'},
            {label: 'Glossary', to: '/docs/reference/glossary'},
          ],
        },
        {
          title: 'Tools',
          items: [
            {label: 'FSL', href: 'https://fsl.fmrib.ox.ac.uk/fsl/fslwiki'},
            {label: 'ANTs', href: 'https://github.com/ANTsX/ANTs'},
            {label: 'MRtrix3', href: 'https://www.mrtrix.org/'},
            {label: 'QSIPrep', href: 'https://qsiprep.readthedocs.io/'},
            {label: 'dcm2niix', href: 'https://github.com/rordenlab/dcm2niix'},
            {label: 'pyAFQ', href: 'https://yeatmanlab.github.io/pyAFQ/'},
          ],
        },
        {
          title: 'Next Steps',
          items: [
            {label: 'Outputs for Tractography', to: '/docs/pipeline/required-outputs'},
            {label: 'Worked Example', href: 'https://github.com/DiffusionTensorImaging-Repos/SDN-IMPACT-DTI'},
          ],
        },
      ],
      copyright: `Copyright \u00A9 ${new Date().getFullYear()} Diffusion MRI Preprocessing. Built with Docusaurus.`,
    },
    prism: {
      theme: prismThemes.github,
      darkTheme: prismThemes.dracula,
      additionalLanguages: ['bash', 'python', 'toml', 'json'],
    },
  } satisfies Preset.ThemeConfig,
};

export default config;