site-metadata.js

const {
  coreFrameworks: coreRenderers,
  communityFrameworks: communityRenderers,
  featureGroups,
} = require('./src/content/docs/frameworks');
const versionData = require('./src/util/version-data');

const isDeployPreview = process.env.CONTEXT === 'deploy-preview';
const homepageUrl = isDeployPreview ? process.env.DEPLOY_PRIME_URL : 'https://storybook.js.org';
const gitHubOrg = `https://github.com/storybookjs`;
const npmApiBase = `https://api.npmjs.org/downloads/point/last-month`;
const docsUrl = `${homepageUrl}/docs`;
const essentialsBase = '/docs/react/essentials';
const contributeUrl = `${docsUrl}/react/contribute/how-to-contribute`;

const siteMetadata = {
  ...versionData,
  title: 'Storybook: Frontend workshop for UI development',
  description: `Storybook is a frontend workshop for building UI components and pages in isolation. Thousands of teams use it for UI development, testing, and documentation. It’s open source and free.`,
  ogImage: '/images/social/open-graph.jpg',
  ogImageAddons: '/images/social/og-addons.jpg',
  ogImageHome: '/images/social/og-home.jpg',
  siteUrl: homepageUrl, // Used for gatsby-plugin-sitemap
  googleSiteVerification: '_OxxMv1o0aRcxPfieLW0BRsMxxIzkpA9Vv6O0AB5xg0',
  contributorCount: 1440,
  algoliaDocSearchConfig: {
    appId: '6L6UWBTLCK',
    indexName: 'storybook-js',
  },
  allRenderers: [...coreRenderers, ...communityRenderers],
  coreRenderers,
  communityRenderers,
  defaultRenderer: 'react',
  // These "framework" properties are used by other SB sites, so we need to keep them here for now
  coreFrameworks: coreRenderers,
  communityFrameworks: communityRenderers,
  defaultFramework: 'react',
  featureGroups,
  urls: {
    gitHubOrg,
    homepageUrl,
    docsUrl,
    contributeUrl,
    npmApiBase,
    gitHub: {
      repo: `${gitHubOrg}/storybook`,
      frontpage: `${gitHubOrg}/frontpage`,
      issues: `${gitHubOrg}/storybook/issues`,
      releases: `${gitHubOrg}/storybook/releases`,
      contributors: `${gitHubOrg}/storybook/graphs/contributors`,
      brand: `${gitHubOrg}/press`,
    },

    npm: `https://www.npmjs.com/package/@storybook/react`,
    openCollective: `https://opencollective.com/storybook`,

    npmApi: {
      react: `${npmApiBase}/@storybook/react`,
      reactNative: `${npmApiBase}/@storybook/react-native`,
      vue: `${npmApiBase}/@storybook/vue`,
      angular: `${npmApiBase}/@storybook/angular`,
      ember: `${npmApiBase}/@storybook/ember`,
      html: `${npmApiBase}/@storybook/html`,
      svelte: `${npmApiBase}/@storybook/svelte`,
      mithril: `${npmApiBase}/@storybook/mithril`,
      riot: `${npmApiBase}/@storybook/riot`,
      polymer: `${npmApiBase}/@storybook/polymer`,
      preact: `${npmApiBase}/@storybook/preact`,
    },

    // Navigation
    home: homepageUrl,
    showcase: `https://storybook.js.org/showcase/`,
    docs: '/docs/',
    tutorials: `https://storybook.js.org/tutorials/`,
    integrations: `/integrations/`,
    addons: `/addons/`,
    recipes: `/recipes/`,
    community: `/community/`,
    useCases: `/use-cases/`,
    releases: '/releases/',
    support: `/support/`,
    telemetry: `/telemetry/`,
    team: `/team/`,
    addonsApi: '/docs/react/addons/addons-api/',
    // This slug is also used to exclude some pages from the sitemap in gatsby-config.js
    installDocsPageSlug:
      versionData.version >= 8 ? '/docs/get-started/' : '/docs/get-started/install/',

    // Social
    blog: `https://storybook.js.org/blog`,
    medium: `https://medium.com/storybookjs`,
    twitter: `https://twitter.com/storybookjs`,
    chat: `https://discord.gg/storybook`,
    youtube: `https://www.youtube.com/channel/UCr7Quur3eIyA_oe8FNYexfg`,

    // Brand
    brand: `${gitHubOrg}/brand`,
    designSystem: `${gitHubOrg}/design-system`,
    badge: `${gitHubOrg}/brand/tree/master/badge`,
    presentation: `${gitHubOrg}/brand/tree/master/presentation`,
    video: `${gitHubOrg}/brand/tree/master/video`,

    // Official addons
    officialAddons: {
      docs: '/docs/addons/',
      install: '/docs/addons/install-addons/',
      create: '/docs/addons/writing-addons/',
      publish: '/docs/addons/integration-catalog/',
      controls: `${essentialsBase}/controls`,
      actions: `${essentialsBase}/actions`,
      viewport: `${essentialsBase}/viewport`,
      backgrounds: `${essentialsBase}/backgrounds`,
      toolbars: `${essentialsBase}/toolbars-and-globals`,
      knobs: `${gitHubOrg}/storybook/tree/master/addons/knobs`,
      source: `${gitHubOrg}/storybook/tree/master/addons/storysource`,
      info: `${gitHubOrg}/storybook/tree/master/addons/info`,
      notes: `${gitHubOrg}/storybook/tree/master/addons/notes`,
      storyshots: `${gitHubOrg}/storybook/tree/master/addons/storyshots`,
      accessibility: `${gitHubOrg}/storybook/tree/master/addons/a11y`,
      console: `${gitHubOrg}/storybook-addon-console`,
      links: `${gitHubOrg}/storybook/tree/master/addons/links`,
    },
  },
};

siteMetadata.urls.navCommunityLinks = [
  { title: 'Blog', href: siteMetadata.urls.blog, isGatsby: false },
  { title: 'Releases', href: siteMetadata.urls.releases, isGatsby: true },
  { title: 'Get involved', href: siteMetadata.urls.community, isGatsby: true },
  { title: 'Use cases', href: siteMetadata.urls.useCases, isGatsby: true },
  { title: 'Support', href: siteMetadata.urls.support, isGatsby: true },
  { title: 'Team', href: siteMetadata.urls.team, isGatsby: true },
];

siteMetadata.urls.navLinks = [
  { title: 'Showcase', href: siteMetadata.urls.showcase, isGatsby: false },
  { title: 'Docs', href: siteMetadata.urls.docsUrl, isGatsby: false },
  { title: 'Tutorials', href: siteMetadata.urls.tutorials, isGatsby: false },
  { title: 'Integrations', href: siteMetadata.urls.integrations, isGatsby: true },
  ...siteMetadata.urls.navCommunityLinks,
];

siteMetadata.urls.addonsLearnLinks = [
  {
    title: 'How to install addons',
    icon: 'book',
    to: siteMetadata.urls.officialAddons.install,
  },
  {
    title: 'Create an addon',
    icon: 'edit',
    to: siteMetadata.urls.officialAddons.create,
  },
];

module.exports = siteMetadata;