hasura/graphql-engine
1
0
Fork 0
mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-15 17:31:56 +03:00
Code Issues Projects Releases Wiki Activity
c9a5d51c70
graphql-engine/docs/docusaurus.config.js
Rikin Kachhia cc30f08f6e docs: move docs-new to docs 
PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4261
GitOrigin-RevId: 3d80068acdd61b5350fc36ec3444db47508f9c09
2022-04-13 12:01:50 +00:00

396 lines
13 KiB
JavaScript
Raw Blame History

// @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');
/** @type {import('@docusaurus/types').Config} */
const config = {
title: 'Hasura GraphQL Docs',
tagline: 'Instant GraphQL on all your data',
url: 'https://hasura.io',
baseUrl: '/docs/',
trailingSlash: true,
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
favicon: '/docs/img/favicon.png',
organizationName: 'hasura',
projectName: 'graphql-engine',
staticDirectories:["static", "public"],
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: 'latest'
},
}
},
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",
}
],
// [
// 'ideal-image',
// {
// quality: 70,
// max: 1030, // max resized image's size.
// min: 640, // min resized image's size. if original is lower, use that size.
// steps: 2, // the max number of images generated between min and max (inclusive)
// disableInDev: false,
// },
// ],
],
themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
hideableSidebar: true,
autoCollapseSidebarCategories: 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-2', // Increment on change
// content: `⭐️ If you like Docusaurus, give it a star on <a target="_blank" rel="noopener noreferrer" href="https://github.com/facebook/docusaurus">GitHub</a> and follow us on <a target="_blank" rel="noopener noreferrer" href="https://twitter.com/docusaurus" >Twitter</a> ${TwitterSvg}`,
// },
navbar: {
hideOnScroll: false,
title: '',
logo: {
alt: 'Hasura Logo',
src: '/img/logo.svg',
srcDark: '/img/logo-light.svg',
href: 'https://hasura.io'
},
items: [
{
type: 'dropdown',
label: 'Docs',
position: 'left',
items: [
{
type: 'doc',
docId: 'graphql/core/index',
label: 'Hasura GraphQL Engine',
},
{
type: 'docSidebar',
sidebarId: 'cloudDocsSidebar',
label: 'Hasura Cloud',
},
],
},
{
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',
},
{
type: 'docsVersionDropdown',
position: 'right',
dropdownActiveClassDisabled: true,
dropdownItemsAfter: [
{
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=try-hasura&tech=default',
label: 'Get Started',
position: 'right',
className: "nav-link_getting-started",
},
],
},
// footer: {
// style: 'light',
// links: [
// {
// title: 'Hasura',
// items: [
// {
// label: 'About Us',
// to: 'https://hasura.io/about/',
// },
// {
// label: 'Press',
// to: 'https://hasura.io/press/',
// },
// {
// label: 'Careers',
// to: 'https://hasura.io/careers/',
// },
// {
// label: 'Contact Us',
// to: 'https://hasura.io/contact-us/',
// },
// {
// label: 'Legal Stuff',
// to: 'https://hasura.io/legal/',
// },
// ],
// },
// {
// title: 'Support',
// items: [
// {
// label: 'Documentation',
// to: '/latest/graphql/core/index',
// },
// {
// label: 'Community Forum',
// to: 'https://discordapp.com/invite/hasura',
// },
// {
// label: 'Help',
// to: 'https://hasura.io/help/',
// },
// {
// label: 'Github',
// to: 'https://github.com/hasura',
// },
// {
// label: 'Hasura Cloud Status',
// to: 'https://status.hasura.io/',
// },
// ],
// },
// {
// title: 'Tools',
// items: [
// {
// label: 'Graphqurl',
// to: 'https://github.com/hasura/graphqurl',
// },
// {
// label: 'Firebase2GraphQL',
// to: 'https://github.com/hasura/firebase2graphql',
// },
// {
// label: 'JSON2GraphQL',
// to: 'https://github.com/hasura/json2graphql',
// },
// {
// label: 'GraphQL2ChartJS',
// to: 'https://github.com/hasura/graphql2chartjs',
// },
// ],
// },
// {
// title: 'Product',
// items: [
// {
// label: 'Hasura Open Source',
// to: 'https://hasura.io/opensource/',
// },
// {
// label: 'Hasura Cloud',
// to: 'https://hasura.io/cloud/',
// },
// {
// label: 'Hasura Enterprise',
// to: 'https://hasura.io/enterprise/',
// },
// {
// label: 'Pricing',
// to: 'https://hasura.io/pricing/',
// },
// {
// label: 'Changelog',
// to: 'https://github.com/hasura/graphql-engine/releases',
// },
// ],
// },
// {
// title: 'Resources',
// items: [
// {
// label: 'Blog',
// to: 'https://hasura.io/blog/',
// },
// {
// label: 'Case Studies',
// to: 'https://hasura.io/case-studies/',
// },
// {
// label: '3Factor Apps',
// to: 'https://3factor.app/',
// },
// {
// label: 'Event Driven Programming',
// to: 'https://hasura.io/event-driven-programming/',
// },
// {
// label: 'React GraphQL',
// to: 'https://hasura.io/react-graphql/',
// },
// {
// label: 'Vue GraphQL',
// to: 'https://hasura.io/vue-graphql/',
// },
// {
// label: 'DIY GraphQL BaaS',
// to: 'https://hasura.io/diy-graphql-baas/',
// },
// {
// label: 'GraphQL & Hasura',
// to: 'https://hasura.io/graphql/',
// },
// {
// label: 'Hasura Cloud Security',
// to: 'https://hasura.io/security/',
// },
// ],
// },
// {
// title: 'Community',
// items: [
// {
// label: 'Community Resources',
// to: 'https://hasura.io/community/',
// },
// {
// label: 'GraphQL Tutorials',
// to: 'https://hasura.io/learn/',
// },
// {
// label: 'Community Wiki',
// to: 'https://github.com/hasura/graphql-engine/wiki',
// },
// {
// label: 'Sample Apps',
// to: 'https://hasura.io/sample-apps/',
// },
// {
// label: 'Partnership Program',
// to: 'https://hasura.io/partner-agencies/',
// },
// {
// label: 'HasuraCon 2021',
// to: 'https://hasura.io/events/hasura-con-2021/',
// },
// {
// label: 'GraphQL Asia',
// to: 'https://graphql.asia/',
// },
// ],
// },
// ],
// copyright: `Copyright © ${new Date().getFullYear()} Hasura Inc. All rights reserved`,
// },
}),
};
module.exports = config;
Reference in New Issue View Git Blame Copy Permalink