Files
tkmind_go/documentation/docusaurus.config.ts
T

255 lines
6.6 KiB
TypeScript
Raw Normal View History

2025-01-24 13:04:43 -08:00
import { themes as prismThemes } from "prism-react-renderer";
import type { Config } from "@docusaurus/types";
import type * as Preset from "@docusaurus/preset-classic";
2025-03-24 14:56:40 +01:00
import tailwindPlugin from "./plugins/tailwind-config.cjs";
2025-01-24 13:04:43 -08:00
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
2025-01-26 12:38:46 -05:00
require("dotenv").config();
2025-01-24 23:05:43 +01:00
const inkeepApiKey = process.env.INKEEP_API_KEY;
const inkeepIntegrationId = process.env.INKEEP_INTEGRATION_ID;
const inkeepOrgId = process.env.INKEEP_ORG_ID;
2025-01-24 13:04:43 -08:00
const config: Config = {
title: "codename goose",
tagline:
2025-01-26 12:38:46 -05:00
"Your on-machine AI agent, automating engineering tasks seamlessly.",
2025-01-24 13:04:43 -08:00
favicon: "img/favicon.ico",
// Set the production url of your site here
url: "https://block.github.io/",
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
2025-02-03 20:01:58 -08:00
baseUrl: process.env.TARGET_PATH || "/goose/",
2025-01-24 13:04:43 -08:00
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "block", // Usually your GitHub org/user name.
projectName: "goose", // Usually your repo name.
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
// 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"],
},
presets: [
[
"classic",
{
docs: {
sidebarPath: "./sidebars.ts",
},
blog: {
showReadingTime: true,
feedOptions: {
type: ["rss", "atom"],
xslt: true,
},
// Useful options to enforce blogging best practices
onInlineTags: "warn",
onInlineAuthors: "warn",
onUntruncatedBlogPosts: "warn",
2025-03-17 18:30:21 +01:00
blogSidebarCount: 'ALL'
2025-01-24 13:04:43 -08:00
},
theme: {
2025-03-24 14:56:40 +01:00
customCss: [
"./src/css/custom.css",
"./src/css/extensions.css",
"./src/css/tailwind.css",
],
2025-01-24 13:04:43 -08:00
},
} satisfies Preset.Options,
],
],
2025-01-28 16:21:27 +01:00
plugins: [
[
"@docusaurus/plugin-client-redirects",
{
redirects: [
{
from: '/docs/getting-started/using-goose-free',
2025-02-05 08:09:47 -06:00
to: '/docs/getting-started/providers#using-goose-for-free'
},
2025-01-28 16:21:27 +01:00
{
from: '/v1/docs/getting-started/providers',
2025-02-05 08:09:47 -06:00
to: '/docs/getting-started/providers'
2025-01-28 16:21:27 +01:00
},
{
from: '/v1/docs/getting-started/installation',
2025-02-05 08:09:47 -06:00
to: '/docs/getting-started/installation'
2025-01-28 16:21:27 +01:00
},
{
2025-01-28 16:31:22 +01:00
from: '/v1/docs/quickstart',
2025-02-05 08:09:47 -06:00
to: '/docs/quickstart'
2025-01-28 16:21:27 +01:00
},
{
from: '/v1/',
2025-02-05 08:09:47 -06:00
to: '/'
2025-01-31 13:22:57 -06:00
},
{
2025-02-05 08:09:47 -06:00
from: '/docs/guides/custom-extensions',
to: '/docs/tutorials/custom-extensions'
},
{
from: '/docs',
to: '/docs/category/getting-started'
2025-03-24 14:56:40 +01:00
},
{
from: '/v1/extensions',
to: '/extensions'
}
2025-03-24 14:56:40 +01:00
],
2025-01-28 16:21:27 +01:00
},
],
2025-03-24 14:56:40 +01:00
tailwindPlugin,
2025-01-28 16:21:27 +01:00
],
2025-01-24 23:05:43 +01:00
themes: ["@inkeep/docusaurus/chatButton", "@inkeep/docusaurus/searchBar"],
2025-01-24 13:04:43 -08:00
themeConfig: {
// Replace with your project's social card
image: "img/home-banner.png",
navbar: {
title: "",
logo: {
alt: "Block Logo",
src: "img/logo_light.png",
srcDark: "img/logo_dark.png",
},
items: [
{
to: "/docs/quickstart",
label: "Quickstart",
position: "left",
},
2025-02-24 07:47:46 -06:00
{
2025-03-24 14:56:40 +01:00
to: "/extensions",
2025-02-24 07:47:46 -06:00
label: "Extensions",
position: "left",
},
2025-01-24 13:04:43 -08:00
{
2025-01-25 10:14:27 -06:00
to: "/docs/category/getting-started",
2025-01-24 13:04:43 -08:00
position: "left",
label: "Docs",
},
2025-03-24 14:56:40 +01:00
2025-01-24 13:04:43 -08:00
{
2025-02-24 07:47:46 -06:00
to: "/docs/category/tutorials",
2025-01-24 13:04:43 -08:00
position: "left",
2025-02-24 07:47:46 -06:00
label: "Tutorials",
2025-01-24 13:04:43 -08:00
},
2025-03-31 07:29:37 -04:00
{
to: "/prompt-library",
position: "left",
label: "Prompt Library",
},
2025-02-24 07:47:46 -06:00
{ to: "/blog", label: "Blog", position: "left" },
2025-01-24 13:04:43 -08:00
{
href: "https://discord.gg/block-opensource",
label: "Discord",
2025-02-24 07:47:46 -06:00
position: "right",
2025-01-24 13:04:43 -08:00
},
{
href: "https://github.com/block/goose",
label: "GitHub",
2025-02-24 07:47:46 -06:00
position: "right",
2025-01-24 13:04:43 -08:00
},
],
},
footer: {
links: [
{
2025-01-25 10:14:27 -06:00
title: "Quick Links",
2025-01-24 13:04:43 -08:00
items: [
{
2025-01-25 10:14:27 -06:00
label: "Install Goose",
to: "docs/getting-started/installation",
},
{
label: "Extensions",
2025-03-24 14:56:40 +01:00
to: "/extensions",
2025-01-24 13:04:43 -08:00
},
],
},
{
title: "Community",
items: [
{
label: "Discord",
href: "https://discord.gg/block-opensource",
},
{
label: "YouTube",
2025-01-27 13:35:23 -06:00
href: "https://www.youtube.com/@blockopensource",
2025-01-24 13:04:43 -08:00
},
{
label: "LinkedIn",
href: "https://www.linkedin.com/company/block-opensource",
},
{
label: "Twitter / X",
href: "https://x.com/blockopensource",
},
{
label: "BlueSky",
2025-02-05 08:46:45 -06:00
href: "https://bsky.app/profile/opensource.block.xyz",
2025-01-24 13:04:43 -08:00
},
2025-02-10 12:13:52 -06:00
{
label: "Nostr",
href: "https://njump.me/opensource@block.xyz",
},
2025-01-24 13:04:43 -08:00
],
},
{
title: "More",
items: [
{
label: "Blog",
to: "/blog",
},
{
label: "GitHub",
href: "https://github.com/block/goose",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} Block, Inc.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.nightOwl,
},
2025-01-24 23:05:43 +01:00
inkeepConfig: {
baseSettings: {
2025-01-26 12:38:46 -05:00
apiKey: inkeepApiKey,
integrationId: inkeepIntegrationId,
organizationId: inkeepOrgId,
primaryBrandColor: "#1E1E1E",
2025-01-24 23:05:43 +01:00
},
aiChatSettings: {
2025-01-26 12:38:46 -05:00
chatSubjectName: "goose",
botAvatarSrcUrl:
2025-01-28 16:21:27 +01:00
"",
2025-01-26 12:38:46 -05:00
getHelpCallToActions: [
{
name: "GitHub",
url: "https://github.com/block/goose",
icon: {
builtIn: "FaGithub",
},
},
],
quickQuestions: ["What is Goose?"],
},
},
2025-01-24 13:04:43 -08:00
} satisfies Preset.ThemeConfig,
};
2025-03-24 14:56:40 +01:00
export default config;