plandev-docs/docusaurus.config.js at develop · NASA-AMMOS/plandev-docs · 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
140
141
142
143
// @ts-check

const lightCodeTheme = require('prism-react-renderer/themes/github');
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
const isDev = process.env.NODE_ENV === 'development';

/** @type {import('@docusaurus/types').Config} */
const config = {
  baseUrl: '/plandev-docs',
  favicon: 'img/favicon-light.svg',
  i18n: {
    defaultLocale: 'en',
    locales: ['en'],
  },
  markdown: {
    mermaid: true,
  },
  onBrokenLinks: 'throw',
  onBrokenMarkdownLinks: 'warn',
  organizationName: 'NASA-AMMOS',
  projectName: 'plandev-docs',
  presets: [
    [
      'classic',
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          editUrl: 'https://github.com/NASA-AMMOS/plandev-docs',
          routeBasePath: '/',
          sidebarPath: require.resolve('./sidebars.js'),
        },
        theme: {
          customCss: require.resolve('./src/css/custom.css'),
        },
      }),
    ],
  ],
  tagline: 'Open-source planning, scheduling, and sequencing for space missions',
  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    ({
      metadata: [
        {
          name: 'description',
          content:
            'PlanDev (formerly Aerie) - Open-source planning, scheduling, and sequencing software for space missions. Developed by NASA AMMOS.',
        },
        {
          name: 'keywords',
          content: 'mission planning, spacecraft sequencing, aerie, plandev, NASA, AMMOS, space missions, scheduling',
        },
        { name: 'algolia-site-verification', content: '614A37BC4AD17B99' },
      ],
      algolia: {
        appId: 'RQ6CI6281X',
        apiKey: '6e89ccaa342a491222b78e98d037e44f',
        indexName: 'PlanDev Docs',
        replaceSearchResultPathname: isDev ? { from: /^\/docs\/next/g, to: '/docs' } : undefined,
      },
      docs: {
        sidebar: {
          autoCollapseCategories: true,
          hideable: true,
        },
      },
      navbar: {
        items: [
          // Left.
          {
            docId: 'introduction',
            label: 'Docs',
            position: 'left',
            type: 'doc',
          },
          {
            label: 'API',
            position: 'left',
            sidebarId: 'api',
            type: 'docSidebar',
          },
          {
            label: 'Upgrade Guides',
            position: 'left',
            sidebarId: 'upgradeGuides',
            type: 'docSidebar',
          },
          // Right.
          // TODO: Uncomment to enable version dropdown.
          // {
          //   dropdownActiveClassDisabled: true,
          //   dropdownItemsAfter: [
          //     {
          //       type: 'html',
          //       value: '<hr class="dropdown-separator">',
          //     },
          //     {
          //       type: 'html',
          //       className: 'dropdown-archived-versions',
          //       value: '<b>Archived versions</b>',
          //     },
          //     {
          //       href: 'https://nasa-ammos.github.io/plandev-docs/1.0.0',
          //       label: '1.0.0',
          //     },
          //   ],
          //   position: 'right',
          //   type: 'docsVersionDropdown',
          // },
          {
            'aria-label': 'GitHub repository',
            className: 'header-github-link',
            href: 'https://github.com/NASA-AMMOS/plandev',
            position: 'right',
          },
        ],
        logo: {
          alt: 'PlanDev Documentation',
          src: 'img/plandev-wordmark-light.svg',
          srcDark: 'img/plandev-wordmark-dark.svg',
          width: 90,
        },
      },
      prism: {
        additionalLanguages: ['graphql', 'java', 'kotlin'],
        darkTheme: darkCodeTheme,
        theme: lightCodeTheme,
      },
      zoom: {
        selector: '.markdown img',
        background: {
          light: 'rgba(255, 255, 255, 0.9)',
          dark: 'rgba(50, 50, 50, 0.9)',
        },
      },
    }),
  plugins: ['docusaurus-plugin-image-zoom'],
  themes: ['@docusaurus/theme-mermaid'],
  title: 'PlanDev Documentation',
  trailingSlash: true,
  url: 'https://nasa-ammos.github.io/',
};

module.exports = config;