mirror of
https://github.com/RooVetGit/Roo-Code.git
synced 2026-08-28 05:27:24 +00:00
451 lines
12 KiB
TypeScript
451 lines
12 KiB
TypeScript
import { themes as prismThemes } from "prism-react-renderer"
|
|
import type { Config } from "@docusaurus/types"
|
|
import type * as Preset from "@docusaurus/preset-classic"
|
|
import {
|
|
TWITTER_URL,
|
|
BLUESKY_URL,
|
|
GITHUB_MAIN_REPO_URL,
|
|
GITHUB_ISSUES_MAIN_URL,
|
|
VSCODE_MARKETPLACE_URL,
|
|
OPEN_VSX_URL,
|
|
EXTENSION_PRIVACY_URL,
|
|
GITHUB_REPO_URL,
|
|
} from "./src/constants"
|
|
|
|
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
|
|
|
|
const config: Config = {
|
|
title: "Roo Code Documentation",
|
|
tagline: "AI-powered autonomous coding agent for VS Code - Complete documentation, guides, and tutorials",
|
|
favicon: "img/favicon.ico",
|
|
|
|
// Set the production url of your site here
|
|
url: "https://roocodeinc.github.io",
|
|
// Set the /<baseUrl>/ pathname under which your site is served
|
|
// For GitHub pages deployment, it is often '/<projectName>/'
|
|
baseUrl: "/Roo-Code/",
|
|
|
|
// GitHub pages deployment config (if needed)
|
|
organizationName: "RooCodeInc",
|
|
projectName: "Roo-Code",
|
|
|
|
onBrokenLinks: "warn",
|
|
markdown: {
|
|
hooks: {
|
|
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"],
|
|
},
|
|
|
|
clientModules: [require.resolve("./src/clientModules/scrollToAnchor.ts")],
|
|
|
|
presets: [
|
|
[
|
|
"classic",
|
|
{
|
|
docs: {
|
|
sidebarPath: "./sidebars.ts",
|
|
routeBasePath: "/",
|
|
editUrl: `${GITHUB_REPO_URL}/edit/main/apps/docs/`,
|
|
showLastUpdateTime: true,
|
|
},
|
|
blog: false, // Disable blog feature
|
|
theme: {
|
|
customCss: "./src/css/custom.css",
|
|
},
|
|
sitemap: false, // Disable the built-in sitemap plugin to avoid conflicts
|
|
} satisfies Preset.Options,
|
|
],
|
|
],
|
|
|
|
themes: [
|
|
[
|
|
require.resolve("@easyops-cn/docusaurus-search-local"),
|
|
{
|
|
hashed: true,
|
|
language: ["en"],
|
|
highlightSearchTermsOnTargetPage: true,
|
|
explicitSearchResultPath: true,
|
|
docsRouteBasePath: "/",
|
|
indexBlog: false,
|
|
searchContextByPaths: [
|
|
{ label: "Getting Started", path: "getting-started" },
|
|
{ label: "Basic Usage", path: "basic-usage" },
|
|
{ label: "Features", path: "features" },
|
|
{ label: "Advanced Usage", path: "advanced-usage" },
|
|
{ label: "Providers", path: "providers" },
|
|
{ label: "Release Notes", path: "update-notes" },
|
|
],
|
|
useAllContextsWithNoSearchContext: true,
|
|
},
|
|
],
|
|
],
|
|
|
|
plugins: [
|
|
[
|
|
"@docusaurus/plugin-sitemap",
|
|
{
|
|
changefreq: "weekly",
|
|
priority: 0.5,
|
|
ignorePatterns: ["/tags/**"],
|
|
filename: "sitemap.xml",
|
|
createSitemapItems: async (params) => {
|
|
const { defaultCreateSitemapItems, ...rest } = params
|
|
const items = await defaultCreateSitemapItems(rest)
|
|
return items.filter((item) => !item.url.includes("/page/"))
|
|
},
|
|
},
|
|
],
|
|
[
|
|
"@docusaurus/plugin-client-redirects",
|
|
{
|
|
redirects: [
|
|
// Files moved from advanced-usage to features
|
|
{
|
|
to: "/features/checkpoints",
|
|
from: ["/advanced-usage/checkpoints"],
|
|
},
|
|
{
|
|
to: "/features/code-actions",
|
|
from: ["/advanced-usage/code-actions"],
|
|
},
|
|
{
|
|
to: "/features/custom-instructions",
|
|
from: ["/advanced-usage/custom-instructions"],
|
|
},
|
|
{
|
|
to: "/features/custom-modes",
|
|
from: ["/advanced-usage/custom-modes"],
|
|
},
|
|
{
|
|
to: "/features/enhance-prompt",
|
|
from: ["/advanced-usage/enhance-prompt"],
|
|
},
|
|
{
|
|
to: "/features/experimental/experimental-features",
|
|
from: ["/advanced-usage/experimental-features"],
|
|
},
|
|
{
|
|
to: "/features/concurrent-file-reads",
|
|
from: ["/features/experimental/concurrent-file-reads"],
|
|
},
|
|
{
|
|
to: "/features/model-temperature",
|
|
from: ["/advanced-usage/model-temperature"],
|
|
},
|
|
{
|
|
to: "/features/auto-approving-actions",
|
|
from: ["/advanced-usage/auto-approving-actions"],
|
|
},
|
|
{
|
|
to: "/features/api-configuration-profiles",
|
|
from: ["/advanced-usage/api-configuration-profiles"],
|
|
},
|
|
{
|
|
to: "/features/intelligent-context-condensing",
|
|
from: [
|
|
"/features/experimental/intelligent-context-condensing",
|
|
"/features/experimental/intelligent-context-condensation",
|
|
],
|
|
},
|
|
{
|
|
to: "/features/experimental/experimental-features",
|
|
from: ["/features/experimental/power-steering"],
|
|
},
|
|
{
|
|
to: "/features/codebase-indexing",
|
|
from: ["/features/experimental/codebase-indexing"],
|
|
},
|
|
|
|
// MCP related redirects
|
|
{
|
|
to: "/features/mcp/overview",
|
|
from: ["/advanced-usage/mcp", "/mcp/overview"],
|
|
},
|
|
{
|
|
to: "/features/mcp/using-mcp-in-roo",
|
|
from: ["/mcp/using-mcp-in-roo"],
|
|
},
|
|
{
|
|
to: "/features/mcp/what-is-mcp",
|
|
from: ["/mcp/what-is-mcp"],
|
|
},
|
|
{
|
|
to: "/features/mcp/server-transports",
|
|
from: ["/mcp/server-transports"],
|
|
},
|
|
{
|
|
to: "/features/mcp/mcp-vs-api",
|
|
from: ["/mcp/mcp-vs-api"],
|
|
},
|
|
{
|
|
to: "/features/shell-integration",
|
|
from: ["/troubleshooting/shell-integration"],
|
|
},
|
|
|
|
// Tools folder moved from features to advanced-usage
|
|
{
|
|
to: "/advanced-usage/available-tools/access-mcp-resource",
|
|
from: ["/features/tools/access-mcp-resource"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/apply-diff",
|
|
from: ["/features/tools/apply-diff"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/ask-followup-question",
|
|
from: ["/features/tools/ask-followup-question"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/attempt-completion",
|
|
from: ["/features/tools/attempt-completion"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/tool-use-overview",
|
|
from: ["/features/tools/browser-action", "/advanced-usage/available-tools/browser-action"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/execute-command",
|
|
from: ["/features/tools/execute-command"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/tool-use-overview",
|
|
from: ["/features/tools/insert-content", "/advanced-usage/available-tools/insert-content"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/tool-use-overview",
|
|
from: [
|
|
"/features/tools/list-code-definition-names",
|
|
"/advanced-usage/available-tools/list-code-definition-names",
|
|
],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/list-files",
|
|
from: ["/features/tools/list-files"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/new-task",
|
|
from: ["/features/tools/new-task"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/read-file",
|
|
from: ["/features/tools/read-file"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/search-files",
|
|
from: ["/features/tools/search-files"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/switch-mode",
|
|
from: ["/features/tools/switch-mode"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/tool-use-overview",
|
|
from: ["/features/tools/tool-use-overview"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/use-mcp-tool",
|
|
from: ["/features/tools/use-mcp-tool"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/available-tools/write-to-file",
|
|
from: ["/features/tools/write-to-file"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/roo-code-nightly",
|
|
from: ["/advanced-usage/prerelease-build"],
|
|
},
|
|
// Redirect removed Roo Code Router provider aliases
|
|
{
|
|
to: "/providers",
|
|
from: ["/providers/roo"],
|
|
},
|
|
{
|
|
to: "/providers",
|
|
from: ["/providers/roo-code-cloud"],
|
|
},
|
|
{
|
|
to: "/providers",
|
|
from: ["/roo-code-provider", "/roo-code-provider/overview"],
|
|
},
|
|
// Redirect removed Cloud, Router, Credits, and billing pages
|
|
{
|
|
to: "/",
|
|
from: [
|
|
"/sunset",
|
|
"/roo-code-cloud",
|
|
"/roo-code-cloud/overview",
|
|
"/roo-code-cloud/login",
|
|
"/roo-code-cloud/connect",
|
|
"/roo-code-cloud/cloud-agents",
|
|
"/roo-code-cloud/environments",
|
|
"/roo-code-cloud/task-sync",
|
|
"/roo-code-cloud/task-sharing",
|
|
"/roo-code-cloud/analytics",
|
|
"/roo-code-cloud/github-integration",
|
|
"/roo-code-cloud/slack-integration",
|
|
"/roo-code-cloud/team-plan",
|
|
"/roo-code-cloud/what-is-roo-code-cloud",
|
|
"/roo-code-cloud/dashboard",
|
|
"/roo-code-cloud/roomote-control",
|
|
],
|
|
},
|
|
{
|
|
to: "/providers",
|
|
from: ["/roo-code-router", "/roo-code-router/overview", "/providers/roo-code-router"],
|
|
},
|
|
{
|
|
to: "/advanced-usage/rate-limits-costs",
|
|
from: ["/credits", "/credits/overview", "/roo-code-cloud/billing-subscriptions"],
|
|
},
|
|
// Redirect removed Human Relay provider page
|
|
{
|
|
to: "/",
|
|
from: ["/providers/human-relay"],
|
|
},
|
|
// Redirect removed Claude Code provider page
|
|
{
|
|
to: "/",
|
|
from: ["/providers/claude-code"],
|
|
},
|
|
|
|
// Redirect removed Fast Edits feature page
|
|
{
|
|
to: "/",
|
|
from: ["/features/fast-edits"],
|
|
},
|
|
// Redirect retired provider pages
|
|
{
|
|
to: "/providers",
|
|
from: [
|
|
"/providers/cerebras",
|
|
"/providers/chutes",
|
|
"/providers/deepinfra",
|
|
"/providers/doubao",
|
|
"/providers/featherless",
|
|
"/providers/glama",
|
|
"/providers/groq",
|
|
"/providers/huggingface",
|
|
"/providers/io-intelligence",
|
|
"/providers/unbound",
|
|
],
|
|
},
|
|
|
|
// Redirect removed browser-use feature page
|
|
{
|
|
to: "/features",
|
|
from: ["/features/browser-use"],
|
|
},
|
|
],
|
|
},
|
|
],
|
|
],
|
|
|
|
themeConfig: {
|
|
// SEO metadata
|
|
metadata: [
|
|
{
|
|
name: "keywords",
|
|
content:
|
|
"Roo Code, AI coding assistant, VS Code extension, autonomous coding agent, AI pair programmer, code generation, documentation",
|
|
},
|
|
{ name: "twitter:card", content: "summary_large_image" },
|
|
{ name: "twitter:site", content: "@roocode" },
|
|
{ name: "twitter:creator", content: "@roocode" },
|
|
{ property: "og:type", content: "website" },
|
|
{ property: "og:locale", content: "en_US" },
|
|
],
|
|
colorMode: {
|
|
defaultMode: "dark",
|
|
disableSwitch: false,
|
|
respectPrefersColorScheme: false,
|
|
},
|
|
image: "/img/social-share.png", // Default Open Graph image
|
|
navbar: {
|
|
logo: {
|
|
alt: "Roo Code Logo",
|
|
src: "img/roo-code-logo-dark.svg",
|
|
srcDark: "img/roo-code-logo-white.svg",
|
|
},
|
|
items: [
|
|
{
|
|
type: "search",
|
|
position: "left",
|
|
},
|
|
],
|
|
},
|
|
footer: {
|
|
style: "dark",
|
|
logo: {
|
|
alt: "Roo Code Logo",
|
|
src: "img/roo-code-logo-dark.svg",
|
|
srcDark: "img/roo-code-logo-white.svg",
|
|
width: 120,
|
|
height: 24,
|
|
},
|
|
links: [
|
|
{
|
|
title: "Social",
|
|
items: [
|
|
{
|
|
label: "Twitter",
|
|
href: TWITTER_URL,
|
|
},
|
|
{
|
|
label: "Bluesky",
|
|
href: BLUESKY_URL,
|
|
},
|
|
{
|
|
label: "GitHub",
|
|
href: GITHUB_MAIN_REPO_URL,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: "GitHub",
|
|
items: [
|
|
{
|
|
label: "Issues",
|
|
href: GITHUB_ISSUES_MAIN_URL,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: "Download",
|
|
items: [
|
|
{
|
|
label: "VS Code Marketplace",
|
|
href: VSCODE_MARKETPLACE_URL,
|
|
},
|
|
{
|
|
label: "Open VSX Registry",
|
|
href: OPEN_VSX_URL,
|
|
},
|
|
],
|
|
},
|
|
{
|
|
title: "Privacy",
|
|
items: [
|
|
{
|
|
label: "Extension Privacy Policy",
|
|
href: EXTENSION_PRIVACY_URL,
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
prism: {
|
|
theme: prismThemes.github,
|
|
darkTheme: prismThemes.dracula,
|
|
},
|
|
} satisfies Preset.ThemeConfig,
|
|
}
|
|
|
|
export default config
|