Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
114 changes: 57 additions & 57 deletions spiceaidocs/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -1,48 +1,48 @@
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
import { themes as prismThemes } from 'prism-react-renderer';
import type { Config } from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';

const config: Config = {
title: "Spice.ai Docs",
title: 'Spice.ai Docs',
tagline:
"A unified SQL query interface and portable runtime to locally materialize, accelerate, and query data tables sourced from any database, data warehouse, or data lake.",
favicon: "img/favicon.ico",
'A unified SQL query interface and portable runtime to locally materialize, accelerate, and query data tables sourced from any database, data warehouse, or data lake.',
favicon: 'img/favicon.ico',

// Set the production url of your site here
url: "https://docs.spiceai.org",
url: 'https://docs.spiceai.org',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: "/",
baseUrl: '/',

trailingSlash: false,

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "spiceai", // Usually your GitHub org/user name.
projectName: "docs", // Usually your repo name.
organizationName: 'spiceai', // Usually your GitHub org/user name.
projectName: 'docs', // Usually your repo name.

onBrokenLinks: "throw",
onBrokenMarkdownLinks: "throw",
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',

// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: "en",
locales: ["en"],
defaultLocale: 'en',
locales: ['en'],
},

presets: [
[
"classic",
'classic',
{
docs: {
sidebarPath: "./sidebars.ts",
routeBasePath: "/",
editUrl: "https://github.com/spiceai/docs/tree/trunk/spiceaidocs/",
sidebarPath: './sidebars.ts',
routeBasePath: '/',
editUrl: 'https://github.com/spiceai/docs/tree/trunk/spiceaidocs/',
},
theme: {
customCss: "./src/css/custom.css",
customCss: './src/css/custom.css',
},
} satisfies Preset.Options,
],
Expand All @@ -54,94 +54,94 @@ const config: Config = {
announcementBar: {
content:
'We\'ve just released <a href="https://github.com/spiceai/spiceai/releases">Spice.ai v0.9.1-alpha</a>! 🚀',
backgroundColor: "#fafbfc",
textColor: "#091E42",
backgroundColor: '#fafbfc',
textColor: '#091E42',
isCloseable: true,
},
navbar: {
title: "Spice.ai Docs",
title: 'Spice.ai Docs',
logo: {
alt: "Spice.ai logo",
src: "img/logo.svg",
alt: 'Spice.ai logo',
src: 'img/logo.svg',
},
hideOnScroll: true,
items: [
{
type: "doc",
docId: "getting-started/index",
position: "left",
label: "Getting Started",
type: 'doc',
docId: 'getting-started/index',
position: 'left',
label: 'Getting Started',
},
{
label: "Blog",
href: "https://blog.spiceai.org",
position: "right",
label: 'Blog',
href: 'https://blog.spiceai.org',
position: 'right',
},
{
href: "https://github.com/spiceai/spiceai",
label: "GitHub",
position: "right",
href: 'https://github.com/spiceai/spiceai',
label: 'GitHub',
position: 'right',
},
{
label: "Discord",
href: "https://discord.gg/kZnTfneP5u",
position: "right",
label: 'Discord',
href: 'https://discord.gg/kZnTfneP5u',
position: 'right',
},
],
},
footer: {
style: "dark",
style: 'dark',
links: [
{
title: "Docs",
title: 'Docs',
items: [
{
label: "Getting Started",
to: "/getting-started",
label: 'Getting Started',
to: '/getting-started',
},
],
},
{
title: "Community",
title: 'Community',
items: [
{
label: "Reddit",
href: "https://reddit.com/r/spiceai",
label: 'Reddit',
href: 'https://reddit.com/r/spiceai',
},
{
label: "Discord",
href: "https://discord.gg/kZnTfneP5u",
label: 'Discord',
href: 'https://discord.gg/kZnTfneP5u',
},
{
label: "Twitter",
href: "https://twitter.com/spice_ai",
label: 'Twitter',
href: 'https://twitter.com/spice_ai',
},
],
},
{
title: "More",
title: 'More',
items: [
{
label: "Blog",
href: "https://blog.spiceai.org",
label: 'Blog',
href: 'https://blog.spiceai.org',
},
{
label: "GitHub",
href: "https://github.com/spiceai/spiceai",
label: 'GitHub',
href: 'https://github.com/spiceai/spiceai',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Spice AI.`,
copyright: `Copyright © ${new Date().getFullYear()} Spice AI, Inc.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
algolia: {
appId: "0SP8I8JTL8",
apiKey: "72f66fe334ccd3c7db696a123d68735c",
indexName: "spiceai",
appId: '0SP8I8JTL8',
apiKey: '72f66fe334ccd3c7db696a123d68735c',
indexName: 'spiceai',
contextualSearch: false,
},
} satisfies Preset.ThemeConfig,
Expand Down