mirror of
https://github.com/hasura/graphql-engine.git
synced 2025-01-05 22:34:22 +03:00
3c69cebb1f
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/11106 GitOrigin-RevId: aed07c10184dfb3d40ddb0d6fcbf818c7b169ed4
290 lines
9.4 KiB
JavaScript
290 lines
9.4 KiB
JavaScript
// @ts-check
|
||
// Note: type annotations allow type checking and IDEs autocompletion
|
||
|
||
const path = require('path');
|
||
const lightCodeTheme = require('prism-react-renderer/themes/vsLight');
|
||
const darkCodeTheme = require('prism-react-renderer/themes/dracula');
|
||
|
||
const DOCS_SERVER_ROOT_URLS = {
|
||
development: 'localhost:8000',
|
||
production: 'website-api.hasura.io',
|
||
staging: 'website-api.stage.hasura.io',
|
||
};
|
||
|
||
const DOCS_SERVER_URLS = {
|
||
development: `http://${DOCS_SERVER_ROOT_URLS.development}`,
|
||
production: `https://${DOCS_SERVER_ROOT_URLS.production}`,
|
||
staging: `https://${DOCS_SERVER_ROOT_URLS.staging}`,
|
||
};
|
||
|
||
const BOT_ROUTES = {
|
||
development: `ws://${DOCS_SERVER_ROOT_URLS.development}/bot/query`,
|
||
production: `wss://${DOCS_SERVER_ROOT_URLS.production}/docs-services/docs-server/bot/query`,
|
||
staging: `wss://${DOCS_SERVER_ROOT_URLS.staging}/docs-services/docs-server/bot/query`,
|
||
};
|
||
|
||
/** @type {import('@docusaurus/types').Config} */
|
||
const config = {
|
||
title: 'Hasura GraphQL Docs',
|
||
tagline: 'Instant GraphQL on all your data',
|
||
url: 'https://hasura.io',
|
||
baseUrl: process.env.CF_PAGES === '1' ? '/' : '/docs/2.0',
|
||
trailingSlash: true,
|
||
onBrokenLinks: 'throw',
|
||
onBrokenMarkdownLinks: 'throw',
|
||
favicon: '/img/favicon.png',
|
||
organizationName: 'hasura',
|
||
projectName: 'graphql-engine',
|
||
staticDirectories: ['static', 'public'],
|
||
customFields: {
|
||
docsBotEndpointURL: (() => {
|
||
if (process.env.CF_PAGES === '1') {
|
||
return BOT_ROUTES.staging; // if we're on CF pages, use the staging environment
|
||
} else {
|
||
const mode = process.env.release_mode;
|
||
if (mode === 'staging') {
|
||
return BOT_ROUTES.production; // use production route for staging
|
||
}
|
||
return BOT_ROUTES[mode ?? 'development'];
|
||
}
|
||
})(),
|
||
docsServerURL: (() => {
|
||
if (process.env.CF_PAGES === '1') {
|
||
return DOCS_SERVER_URLS.staging; // if we're on CF pages, use the staging environment
|
||
} else {
|
||
const mode = process.env.release_mode;
|
||
if (mode === 'staging') {
|
||
return DOCS_SERVER_URLS.production; // use production route for staging
|
||
}
|
||
return DOCS_SERVER_URLS[mode ?? 'development'];
|
||
}
|
||
})(),
|
||
hasuraVersion: 3,
|
||
DEV_TOKEN: process.env.DEV_TOKEN,
|
||
},
|
||
scripts: [],
|
||
webpack: {
|
||
jsLoader: isServer => ({
|
||
loader: require.resolve('swc-loader'),
|
||
options: {
|
||
jsc: {
|
||
parser: {
|
||
syntax: 'typescript',
|
||
tsx: true,
|
||
},
|
||
target: 'es2017',
|
||
},
|
||
module: {
|
||
type: isServer ? 'commonjs' : 'es6',
|
||
},
|
||
},
|
||
}),
|
||
},
|
||
presets: [
|
||
[
|
||
'classic',
|
||
/** @type {import('@docusaurus/preset-classic').Options} */
|
||
({
|
||
docs: {
|
||
routeBasePath: '/',
|
||
sidebarPath: require.resolve('./sidebars.js'),
|
||
editUrl: ({ docPath }) => `https://github.com/hasura/graphql-engine/edit/master/docs/docs/${docPath}`,
|
||
docItemComponent: require.resolve('./src/components/CustomDocItem/index.tsx'),
|
||
exclude: ['**/*.wip'],
|
||
breadcrumbs: true,
|
||
// showLastUpdateAuthor: true,
|
||
// showLastUpdateTime: true,
|
||
lastVersion: 'current',
|
||
versions: {
|
||
current: {
|
||
label: 'v2.x',
|
||
badge: true,
|
||
path: '',
|
||
},
|
||
},
|
||
},
|
||
theme: {
|
||
customCss: require.resolve('./src/css/custom.scss'),
|
||
},
|
||
}),
|
||
],
|
||
],
|
||
plugins: [
|
||
'docusaurus-plugin-sass',
|
||
[
|
||
'content-docs',
|
||
/** @type {import('@docusaurus/plugin-content-docs').Options} */
|
||
({
|
||
id: 'wiki',
|
||
path: 'wiki',
|
||
routeBasePath: 'wiki',
|
||
editUrl: ({ docPath }) => `https://github.com/hasura/graphql-engine/edit/master/docs/docs/${docPath}`,
|
||
editCurrentVersion: true,
|
||
docItemComponent: require.resolve('./src/components/CustomDocItem/CustomDocItemWiki.tsx'),
|
||
// disableVersioning: true,
|
||
breadcrumbs: false,
|
||
sidebarPath: require.resolve('./sidebarsWiki.js'),
|
||
showLastUpdateAuthor: true,
|
||
showLastUpdateTime: true,
|
||
}),
|
||
],
|
||
[
|
||
path.resolve(__dirname, './src/plugins/docusaurus-plugin-segment-analytics'),
|
||
{
|
||
prodKey: 'RQXoHRpNcmBKllUDihjDjupGv4AHn5TB',
|
||
devKey: 'FRKElp5cyMax6GAdM8OVyNMIFVppgEgp',
|
||
// boolean (defaults to false) on whether you want
|
||
// to include analytics.page() automatically
|
||
trackPage: true,
|
||
// number (defaults to 50); time to wait after a route update before it should
|
||
// track the page change, to implement this, make sure your `trackPage` property is set to `true`
|
||
// trackPageDelay: 50,
|
||
},
|
||
],
|
||
[
|
||
path.resolve(__dirname, './src/plugins/docusaurus-plugin-google-gtm'),
|
||
{
|
||
trackingID: 'GTM-PF5MQ2Z',
|
||
},
|
||
],
|
||
],
|
||
|
||
themeConfig:
|
||
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||
({
|
||
docs: {
|
||
sidebar: {
|
||
hideable: true,
|
||
autoCollapseCategories: true,
|
||
},
|
||
},
|
||
colorMode: {
|
||
defaultMode: 'light',
|
||
disableSwitch: false,
|
||
respectPrefersColorScheme: true,
|
||
},
|
||
image: 'https://graphql-engine-cdn.hasura.io/assets/hge-docs/og-image.png',
|
||
prism: {
|
||
theme: lightCodeTheme,
|
||
darkTheme: darkCodeTheme,
|
||
additionalLanguages: ['rest', 'http', 'haskell', 'plsql', 'docker', 'nginx', 'markdown'],
|
||
},
|
||
algolia: {
|
||
// If Algolia did not provide you any appId, use 'BH4D9OD16A'
|
||
appId: 'NS6GBGYACO',
|
||
// Public API key: it is safe to commit it
|
||
apiKey: '8f0f11e3241b59574c5dd32af09acdc8',
|
||
indexName: 'hasura-graphql',
|
||
// Optional: see doc section below
|
||
// contextualSearch: true,
|
||
// Optional: Specify domains where the navigation should occur through window.location instead on history.push. Useful when our Algolia config crawls multiple documentation sites and we want to navigate with window.location.href to them.
|
||
// externalUrlRegex: 'external\\.com|domain\\.com',
|
||
// Optional: Algolia search parameters
|
||
// searchParameters: {},
|
||
},
|
||
announcementBar: {
|
||
id: 'announcementBar-1', // Increment on change
|
||
content: `The new version of Hasura has launched. <a target="_blank" rel="noopener" href="https://hasura.io/docs/3.0/getting-started/quickstart/?utm_source=hasura&utm_medium=v2_docs">Get started with Hasura DDN here.</a>`,
|
||
isCloseable: false,
|
||
// backgroundColor: '#478BCA',
|
||
// textColor: '#091E42',
|
||
},
|
||
// announcementBar: {
|
||
// id: 'announcement-bar-3',
|
||
// content:
|
||
// '<a target="_blank" rel="noopener noreferrer" href="https://hasura.io/events/hasura-con-2022/">Check out the product announcements from HasuraCon’22</a>',
|
||
// backgroundColor: '#511AAA',
|
||
// textColor: '#fff',
|
||
// },
|
||
navbar: {
|
||
hideOnScroll: false,
|
||
title: '',
|
||
logo: {
|
||
alt: 'Hasura Logo',
|
||
src: '/img/logo.svg',
|
||
srcDark: '/img/logo-light.svg',
|
||
href: 'https://hasura.io',
|
||
},
|
||
items: [
|
||
{
|
||
to: 'https://hasura.io/products/',
|
||
label: 'Product',
|
||
position: 'left',
|
||
},
|
||
{
|
||
to: 'https://hasura.io/blog/',
|
||
label: 'Blog',
|
||
position: 'left',
|
||
},
|
||
{
|
||
to: 'https://hasura.io/learn/',
|
||
label: 'Tutorials',
|
||
position: 'left',
|
||
},
|
||
{
|
||
to: 'https://hasura.io/changelog',
|
||
label: "What's New",
|
||
id: 'whats-new-link',
|
||
position: 'left',
|
||
},
|
||
{
|
||
to: '/hasura-cloud/overview',
|
||
label: 'Hasura Cloud',
|
||
className: 'header-hasura-cloud-link',
|
||
position: 'left',
|
||
},
|
||
{
|
||
to: '/enterprise/overview',
|
||
label: 'Hasura Enterprise',
|
||
className: 'header-hasura-ee-link',
|
||
position: 'left',
|
||
},
|
||
{
|
||
type: 'docsVersionDropdown',
|
||
position: 'right',
|
||
dropdownActiveClassDisabled: true,
|
||
dropdownItemsAfter: [
|
||
{
|
||
href: 'https://hasura.io/docs/3.0/index/',
|
||
label: 'v3.x',
|
||
},
|
||
{
|
||
href: 'https://hasura.io/docs/1.0/graphql/core/index.html',
|
||
label: 'v1.x',
|
||
},
|
||
],
|
||
},
|
||
{
|
||
type: 'search',
|
||
position: 'right',
|
||
},
|
||
{
|
||
href: 'https://github.com/hasura/graphql-engine',
|
||
position: 'right',
|
||
className: 'header-github-link',
|
||
'aria-label': 'GitHub repository',
|
||
},
|
||
{
|
||
to: 'https://hasura.io/pricing/',
|
||
label: 'Pricing',
|
||
position: 'right',
|
||
},
|
||
{
|
||
to: 'https://cloud.hasura.io/login?pg=docs&plcmt=header&cta=log-in&tech=default',
|
||
label: 'Login',
|
||
position: 'right',
|
||
className: 'nav-link_login',
|
||
},
|
||
{
|
||
to: 'https://cloud.hasura.io/signup?pg=products&plcmt=header&cta=get_started&tech=default',
|
||
label: 'Get Started',
|
||
position: 'right',
|
||
className: 'nav-link_getting-started',
|
||
},
|
||
],
|
||
},
|
||
}),
|
||
};
|
||
|
||
module.exports = config;
|