siteConfig.js

/**
 * Copyright (c) 2017-present, Facebook, Inc.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

// See https://docusaurus.io/docs/site-config for all the possible
// site configuration options.

// This figures out what the most recent release version is, so that we can link to it in the header
const [{ name: latestRelease }] = require('fs')
  .readdirSync(require('path').resolve(__dirname, '../docs/releases'))
  .map(file => {
    const match = file.match(/^v(\d+)\.(\d+)\.(\d+)\.md$/);
    if (!match) {
      return undefined;
    }
    const parts = match.slice(1).map(v => parseInt(v, 10));
    return {
      name: file.slice(0, file.length - '.md'.length),
      weight: parts[0] * 1000000 + parts[1] * 1000 + parts[2],
    };
  })
  .filter(Boolean)
  .sort((a, b) => b.weight - a.weight);

const siteConfig = {
  title: 'Backstage Software Catalog and Developer Platform', // Title for your website.
  tagline: 'An open platform for building developer portals',
  url: 'https://backstage.io', // Your website URL
  cname: 'backstage.io',
  baseUrl: '/', // Base URL for your project */
  editUrl: 'https://github.com/backstage/backstage/edit/master/docs/',

  // Used for publishing and more
  projectName: 'backstage',
  organizationName: 'Spotify',
  fossWebsite: 'https://spotify.github.io/',

  // Google Analytics
  gaTrackingId: 'G-KSEVGGNCJW',
  gaGtag: true,

  // For no header links in the top nav bar -> headerLinks: [],
  headerLinks: [
    {
      href: 'https://github.com/backstage/backstage',
      label: 'GitHub',
    },
    {
      doc: 'overview/what-is-backstage',
      href: '/docs',
      label: 'Docs',
    },
    {
      page: 'plugins',
      label: 'Plugins',
    },
    {
      page: 'blog',
      blog: true,
      label: 'Blog',
    },
    {
      doc: `releases/${latestRelease}`,
      href: '/releases',
      label: 'Releases',
    },
    {
      page: 'demos',
      label: 'Demos',
    },
    {
      page: 'community',
      label: 'Community',
    },
  ],

  /* path to images for header/footer */
  // headerIcon: "img/android-chrome-192x192.png",
  footerIcon: 'img/android-chrome-192x192.png',
  favicon: 'img/favicon.ico',

  /* Colors for website */
  colors: {
    primaryColor: '#36BAA2',
    secondaryColor: '#121212',
    textColor: '#FFFFFF',
    navigatorTitleTextColor: '#e4e4e4',
    navigatorItemTextColor: '#9e9e9e',
    navGroupSubcategoryTitleColor: '#9e9e9e',
  },

  // This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
  copyright: `Copyright © ${new Date().getFullYear()} Backstage Project Authors. All rights reserved. The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Usage page: https://www.linuxfoundation.org/trademark-usage`,

  highlight: {
    // Highlight.js theme to use for syntax highlighting in code blocks.
    theme: 'monokai',
  },

  // Add custom scripts here that would be placed in <script> tags.
  scripts: [
    'https://buttons.github.io/buttons.js',
    'https://unpkg.com/medium-zoom@1.0.6/dist/medium-zoom.min.js',
    '/js/medium-zoom.js',
    '/js/dismissable-banner.js',
    '/js/scroll-nav-to-view-in-docs.js',
  ],

  // On page navigation for the current documentation page.
  onPageNav: 'separate',
  // No .html extensions for paths.
  cleanUrl: true,

  // Open Graph and Twitter card images.
  ogImage: 'img/sharing-opengraph.png',
  twitterImage: 'img/twitter-summary.png',

  // For sites with a sizable amount of content, set collapsible to true.
  // Expand/collapse the links and subcategories under categories.
  docsSideNavCollapsible: true,

  // Show documentation's last contributor's name.
  // enableUpdateBy: true,

  // Show documentation's last update time.
  enableUpdateTime: true,

  // You may provide arbitrary config keys to be used as needed by your
  // template. For example, if you need your repo's URL...
  repoUrl: 'https://github.com/backstage/backstage',
  twitterUsername: 'SpotifyEng',

  stylesheets: [
    'https://fonts.googleapis.com/css?family=IBM+Plex+Mono:500,700&display=swap',
  ],

  algolia: {
    apiKey: '8d115c9875ba0f4feaee95bab55a1645',
    indexName: 'backstage',
    searchParameters: {}, // Optional (if provided by Algolia)
  },
};

module.exports = siteConfig;