Build time

The build-time configuration file is located in the configuration-path folder. This file runs under a nodejs process and some functionlity is limited (e.g. typescript). Possible names for the file:

by default, author and tags are category page types the following example adds a language category

module.exports = {
  categories: ['author', 'tags', 'language']
  pages: {
    language: {
      basePath: 'lang/',
    },
  },
}

the following example sets up custom page types and routes

module.exports = {
  pages: {
    story: {
      basePath: 'api/',
      tabs: {
        ...defaultBuildConfig.pages.story.tabs,
        test: '@component-controls/pages/TestingPage',
      },
    },
    tutorial: {
      basePath: 'tutorial/',
    },
  },
};

the paths are relative to the config folder where the buildtime.js configuration file is located.

the following example will search for documents in the ../src/docs folder

module.exports = {
  stories: ['../src/docs/*.@(mdx|tsx)'],
};

this option allows to install the component-controls site under a custom sub-folder on a site

the following example will prefix all paths with /docs/

module.exports = {
  siteRoot: '/docs/',
};

the following example will disable automatic generating the sitemap.xml file.

module.exports = {
  siteMap: false,
};

the following example creates options to use modules for CSS class names

module.exports = {
  loaders: {
    'css-loader': {
      modules: {
        localIdentName: '[name].[local].[hash]',
      },
    },
  },
};