import type { BunPressOptions } from '@stacksjs/bunpress' const config: BunPressOptions = { verbose: false, docsDir: './docs', outDir: './dist/docs', // Navigation nav: [ { text: 'Skills', link: '/skills', }, { text: 'Changelog', link: 'https://github.com/stacksjs/stacks/blob/main/CHANGELOG.md', }, { text: 'Resources', items: [ { text: 'Team', link: '/team' }, { text: 'Sponsors', link: '/sponsors' }, { text: 'Partners', link: '/partners' }, { text: 'Postcardware', link: '/postcardware' }, { text: 'Awesome Stacks', link: 'https://github.com/stacksjs/awesome-stacks' }, { text: 'Contributing', link: 'https://github.com/stacksjs/stacks/blob/main/.github/CONTRIBUTING.md' }, ], }, ], // Markdown configuration markdown: { title: 'Stacks Documentation', meta: { description: 'Rapid application, cloud & library development framework.', author: 'Stacks.js', }, syntaxHighlightTheme: 'github-dark', toc: { enabled: true, minDepth: 2, maxDepth: 3, }, sidebar: { '/': [ { text: 'Prologue', collapsed: true, items: [ { text: 'Release Notes', link: '/release-notes' }, { text: 'Upgrade Guide', link: '/upgrade-guide' }, { text: 'Contribution Guide', link: '/contribution-guide' }, { text: 'Sponsors', link: '/sponsors' }, ], }, { text: 'Getting Started', collapsed: true, items: [ { text: 'Introduction', link: '/guide/intro' }, { text: 'Quick Start', link: '/guide/get-started' }, { text: 'StackBlitz', link: '/guide/stackblitz' }, ], }, { text: 'Basics', collapsed: true, items: [ { text: 'Routing', link: '/basics/routing' }, { text: 'Requests', link: '/basics/requests' }, { text: 'Middleware', link: '/basics/middleware' }, { text: 'Models', link: '/basics/models' }, { text: 'Views', link: '/basics/views' }, { text: 'Actions', link: '/basics/actions' }, { text: 'Commands', link: '/basics/commands' }, { text: 'Jobs', link: '/basics/jobs' }, { text: 'Components', link: '/basics/components' }, { text: 'Generated style guides', link: '/basics/style-guide' }, { text: 'Functions', link: '/basics/functions' }, { text: 'Validation', link: '/packages/validation' }, { text: 'Error Handling', link: '/basics/error-handling' }, { text: 'Logging', link: '/basics/logging' }, ], }, { text: 'Digging Deeper', collapsed: true, items: [ { text: 'Authentication', link: '/guide/auth' }, { text: 'Personal Data and GDPR', link: '/guide/gdpr' }, { text: 'Mobile Apps', link: '/guide/mobile' }, { text: 'Package Discovery', link: '/guide/package-discovery' }, { text: 'Database', link: '/packages/database' }, { text: 'Scaling the Database', link: '/guide/database-scaling' }, { text: 'Cache', link: '/packages/cache' }, { text: 'Events', link: '/packages/events' }, { text: 'Queue', link: '/packages/queue' }, { text: 'Notifications', link: '/packages/notifications' }, { text: 'Payments', link: '/packages/payments' }, { text: 'Realtime', link: '/packages/realtime' }, { text: 'Search Engine', link: '/packages/search-engine' }, { text: 'Storage', link: '/packages/storage' }, ], }, { text: 'Cloud', collapsed: true, items: [ { text: 'Deploy', link: '/guide/cloud/deployment' }, { text: 'Raspberry Pi', link: '/guide/cloud/raspberry-pi' }, { text: 'Origin Failover', link: '/guide/cloud/origin-failover' }, { text: 'Extend Cloud', link: '/guide/cloud/extend' }, ], }, { text: 'CLI (Buddy)', collapsed: true, items: [ { text: 'Introduction', link: '/guide/buddy/intro' }, { text: 'Command Reference', link: '/guide/buddy/commands' }, { text: 'Add Stacks', link: '/guide/buddy/add' }, { text: 'Dev', link: '/guide/buddy/dev' }, { text: 'Build', link: '/guide/buddy/build' }, { text: 'Deploy', link: '/guide/buddy/deploy' }, { text: 'Make', link: '/guide/buddy/make' }, { text: 'Migrate', link: '/guide/buddy/migrate' }, { text: 'Database Backups', link: '/guide/buddy/db' }, { text: 'Test', link: '/guide/buddy/test' }, ], }, { text: 'Packages', collapsed: true, items: [ { text: 'STX', link: '/packages/stx' }, { text: 'Actions', link: '/packages/actions' }, { text: 'AI', link: '/packages/ai' }, { text: 'Auth', link: '/packages/auth' }, { text: 'Cache', link: '/packages/cache' }, { text: 'CLI', link: '/packages/cli' }, { text: 'Cloud', link: '/packages/cloud' }, { text: 'Database', link: '/packages/database' }, { text: 'DateTime', link: '/packages/datetime' }, { text: 'ORM', link: '/packages/orm' }, { text: 'Query Builder', link: '/packages/query-builder' }, { text: 'Router', link: '/packages/router' }, { text: 'Testing', link: '/packages/testing' }, { text: 'Validation', link: '/packages/validation' }, ], }, { text: 'Agent Skills', collapsed: true, items: [ { text: 'Overview', link: '/skills' }, { text: 'Using Skills', link: '/skills/using' }, { text: 'Upstream Ports', link: '/skills/upstream' }, { text: 'Flows', link: '/skills/flows' }, { text: 'Writing Your Own', link: '/skills/writing' }, { text: 'Engineering craft', link: '/skills/craft' }, { text: 'Marketing', link: '/skills/marketing' }, { text: 'Productivity and writing', link: '/skills/productivity' }, { text: 'Data layer', link: '/skills/data' }, { text: 'Backend and API', link: '/skills/backend' }, { text: 'Messaging', link: '/skills/messaging' }, { text: 'Frontend', link: '/skills/frontend' }, { text: 'Design', link: '/skills/design' }, { text: 'Domain packages', link: '/skills/domain' }, { text: 'Toolchain', link: '/skills/toolchain' }, { text: 'Platform', link: '/skills/platform' }, { text: 'Utilities', link: '/skills/utilities' }, ], }, { text: 'Testing', collapsed: true, items: [ { text: 'Getting Started', link: '/testing/getting-started' }, { text: 'Unit Tests', link: '/testing/unit-tests' }, { text: 'Feature Tests', link: '/testing/feature-tests' }, { text: 'Http Tests', link: '/testing/http-tests' }, { text: 'Screen documentation', link: '/guide/screenshots' }, ], }, { text: 'Project', collapsed: true, items: [ { text: 'Roadmap', link: '/project/roadmap' }, { text: 'Contributing', link: '/contribution-guide' }, { text: 'License', link: '/project/license' }, ], }, ], '/skills': [ { text: 'Agent Skills', items: [ { text: 'Overview', link: '/skills' }, { text: 'Using Skills', link: '/skills/using' }, { text: 'Flows', link: '/skills/flows' }, { text: 'Writing Your Own', link: '/skills/writing' }, ], }, { text: 'Engineering craft', collapsed: false, items: [ { text: 'All engineering craft skills', link: '/skills/craft' }, { text: 'Software Factory', link: '/skills/craft/software-factory' }, { text: 'Browse', link: '/skills/craft/browse' }, { text: 'Codebase design', link: '/skills/craft/codebase-design' }, { text: 'Domain modeling', link: '/skills/craft/domain-modeling' }, { text: 'Flow', link: '/skills/craft/flow' }, { text: 'Grilling', link: '/skills/craft/grilling' }, { text: 'Guard', link: '/skills/craft/guard' }, { text: 'Handoff', link: '/skills/craft/handoff' }, { text: 'Humanizer', link: '/skills/craft/humanizer' }, { text: 'Investigate', link: '/skills/craft/investigate' }, { text: 'New feature', link: '/skills/craft/new-feature' }, { text: 'New app', link: '/skills/craft/new-app' }, { text: 'Office hours', link: '/skills/craft/office-hours' }, { text: 'Plan review', link: '/skills/craft/plan-review' }, { text: 'Prototype', link: '/skills/craft/prototype' }, { text: 'Retro', link: '/skills/craft/retro' }, { text: 'Review', link: '/skills/craft/review' }, { text: 'Security audit', link: '/skills/craft/security-audit' }, { text: 'TDD', link: '/skills/craft/tdd' }, { text: 'Unslop', link: '/skills/craft/unslop' }, { text: 'Wizard', link: '/skills/craft/wizard' }, { text: 'Writing for agents', link: '/skills/craft/writing-for-agents' }, { text: 'Grill With Docs', link: '/skills/craft/grill-with-docs' }, { text: 'Implement', link: '/skills/craft/implement' }, { text: 'Implement Spec', link: '/skills/craft/implement-spec' }, { text: 'Improve Codebase Architecture', link: '/skills/craft/improve-codebase-architecture' }, { text: 'PR', link: '/skills/craft/pr' }, { text: 'Research', link: '/skills/craft/research' }, { text: 'Scaffold Exercises', link: '/skills/craft/scaffold-exercises' }, { text: 'Setup Deep Modules', link: '/skills/craft/setup-deep-modules' }, { text: 'Setup Engineering', link: '/skills/craft/setup-engineering' }, { text: 'Test Fixtures', link: '/skills/craft/test-fixtures' }, { text: 'To Spec', link: '/skills/craft/to-spec' }, { text: 'To Tickets', link: '/skills/craft/to-tickets' }, { text: 'Triage', link: '/skills/craft/triage' }, { text: 'Upstream', link: '/skills/craft/upstream' }, { text: 'Wayfinder', link: '/skills/craft/wayfinder' }, ], }, { text: 'Marketing', collapsed: true, items: [ { text: 'All marketing skills', link: '/skills/marketing' }, { text: 'Marketing Reverse Engineer Marketing', link: '/skills/marketing/marketing-reverse-engineer-marketing' }, { text: 'Marketing Link Building', link: '/skills/marketing/marketing-link-building' }, { text: 'Marketing Conversion Tracking', link: '/skills/marketing/marketing-conversion-tracking' }, { text: 'Marketing', link: '/skills/marketing/marketing' }, { text: 'Marketing A/B Testing', link: '/skills/marketing/marketing-ab-testing' }, { text: 'Marketing Ad Creative', link: '/skills/marketing/marketing-ad-creative' }, { text: 'Marketing Ads', link: '/skills/marketing/marketing-ads' }, { text: 'Marketing AI SEO', link: '/skills/marketing/marketing-ai-seo' }, { text: 'Marketing Analytics', link: '/skills/marketing/marketing-analytics' }, { text: 'Marketing ASO', link: '/skills/marketing/marketing-aso' }, { text: 'Marketing Attribution', link: '/skills/marketing/marketing-attribution' }, { text: 'Marketing Churn Prevention', link: '/skills/marketing/marketing-churn-prevention' }, { text: 'Marketing Co Marketing', link: '/skills/marketing/marketing-co-marketing' }, { text: 'Marketing Cold Email', link: '/skills/marketing/marketing-cold-email' }, { text: 'Marketing Community Marketing', link: '/skills/marketing/marketing-community-marketing' }, { text: 'Marketing Competitor Profiling', link: '/skills/marketing/marketing-competitor-profiling' }, { text: 'Marketing Competitors', link: '/skills/marketing/marketing-competitors' }, { text: 'Marketing Content Strategy', link: '/skills/marketing/marketing-content-strategy' }, { text: 'Marketing Copy Editing', link: '/skills/marketing/marketing-copy-editing' }, { text: 'Marketing Copywriting', link: '/skills/marketing/marketing-copywriting' }, { text: 'Marketing Council', link: '/skills/marketing/marketing-council' }, { text: 'Marketing CRO', link: '/skills/marketing/marketing-cro' }, { text: 'Marketing Customer Research', link: '/skills/marketing/marketing-customer-research' }, { text: 'Marketing Directory Submissions', link: '/skills/marketing/marketing-directory-submissions' }, { text: 'Marketing Emails', link: '/skills/marketing/marketing-emails' }, { text: 'Marketing Events', link: '/skills/marketing/marketing-events' }, { text: 'Marketing Free Tools', link: '/skills/marketing/marketing-free-tools' }, { text: 'Marketing Ideas', link: '/skills/marketing/marketing-ideas' }, { text: 'Marketing Image', link: '/skills/marketing/marketing-image' }, { text: 'Marketing Influencer Marketing', link: '/skills/marketing/marketing-influencer-marketing' }, { text: 'Marketing Launch', link: '/skills/marketing/marketing-launch' }, { text: 'Marketing Lead Magnets', link: '/skills/marketing/marketing-lead-magnets' }, { text: 'Marketing Loops', link: '/skills/marketing/marketing-loops' }, { text: 'Marketing Offers', link: '/skills/marketing/marketing-offers' }, { text: 'Marketing Onboarding', link: '/skills/marketing/marketing-onboarding' }, { text: 'Marketing Paywalls', link: '/skills/marketing/marketing-paywalls' }, { text: 'Marketing Plan', link: '/skills/marketing/marketing-plan' }, { text: 'Marketing Popups', link: '/skills/marketing/marketing-popups' }, { text: 'Marketing Pricing', link: '/skills/marketing/marketing-pricing' }, { text: 'Marketing Product Marketing', link: '/skills/marketing/marketing-product-marketing' }, { text: 'Marketing Programmatic SEO', link: '/skills/marketing/marketing-programmatic-seo' }, { text: 'Marketing Prospecting', link: '/skills/marketing/marketing-prospecting' }, { text: 'Marketing Psychology', link: '/skills/marketing/marketing-psychology' }, { text: 'Marketing Public Relations', link: '/skills/marketing/marketing-public-relations' }, { text: 'Marketing Referrals', link: '/skills/marketing/marketing-referrals' }, { text: 'Marketing RevOps', link: '/skills/marketing/marketing-revops' }, { text: 'Marketing Sales Enablement', link: '/skills/marketing/marketing-sales-enablement' }, { text: 'Marketing Schema', link: '/skills/marketing/marketing-schema' }, { text: 'Marketing SEO Audit', link: '/skills/marketing/marketing-seo-audit' }, { text: 'Marketing Signup', link: '/skills/marketing/marketing-signup' }, { text: 'Marketing Site Architecture', link: '/skills/marketing/marketing-site-architecture' }, { text: 'Marketing SMS', link: '/skills/marketing/marketing-sms' }, { text: 'Marketing Social', link: '/skills/marketing/marketing-social' }, { text: 'Marketing Video', link: '/skills/marketing/marketing-video' }, ], }, { text: 'Productivity and writing', collapsed: true, items: [ { text: 'All productivity skills', link: '/skills/productivity' }, { text: 'Chief Of Staff', link: '/skills/productivity/chief-of-staff' }, { text: 'Loop', link: '/skills/productivity/loop' }, { text: 'Teach', link: '/skills/productivity/teach' }, { text: 'To Questionnaire', link: '/skills/productivity/to-questionnaire' }, { text: 'Wait What', link: '/skills/productivity/wait-what' }, { text: 'Writing Beats', link: '/skills/productivity/writing-beats' }, { text: 'Writing Fragments', link: '/skills/productivity/writing-fragments' }, { text: 'Writing Shape', link: '/skills/productivity/writing-shape' }, ], }, { text: 'Data layer', collapsed: true, items: [ { text: 'All data layer skills', link: '/skills/data' }, { text: 'Database', link: '/skills/data/database' }, { text: 'Faker', link: '/skills/data/faker' }, { text: 'Migrations', link: '/skills/data/migrations' }, { text: 'Models', link: '/skills/data/models' }, { text: 'ORM', link: '/skills/data/orm' }, { text: 'Query builder', link: '/skills/data/query-builder' }, { text: 'Search engine', link: '/skills/data/search-engine' }, { text: 'Pagination', link: '/skills/data/pagination' }, ], }, { text: 'Backend and API', collapsed: true, items: [ { text: 'All backend and api skills', link: '/skills/backend' }, { text: 'Actions', link: '/skills/backend/actions' }, { text: 'AI', link: '/skills/backend/ai' }, { text: 'API', link: '/skills/backend/api' }, { text: 'Auth', link: '/skills/backend/auth' }, { text: 'Cache', link: '/skills/backend/cache' }, { text: 'Cron', link: '/skills/backend/cron' }, { text: 'Error handling', link: '/skills/backend/error-handling' }, { text: 'Events', link: '/skills/backend/events' }, { text: 'Health', link: '/skills/backend/health' }, { text: 'HTTP', link: '/skills/backend/http' }, { text: 'Jobs', link: '/skills/backend/jobs' }, { text: 'Listeners', link: '/skills/backend/listeners' }, { text: 'Logging', link: '/skills/backend/logging' }, { text: 'Middleware', link: '/skills/backend/middleware' }, { text: 'Queue', link: '/skills/backend/queue' }, { text: 'Realtime', link: '/skills/backend/realtime' }, { text: 'Router', link: '/skills/backend/router' }, { text: 'Routes', link: '/skills/backend/routes' }, { text: 'Scheduler', link: '/skills/backend/scheduler' }, { text: 'Security', link: '/skills/backend/security' }, { text: 'Socials', link: '/skills/backend/socials' }, { text: 'Storage', link: '/skills/backend/storage' }, { text: 'Validation', link: '/skills/backend/validation' }, ], }, { text: 'Messaging', collapsed: true, items: [ { text: 'All messaging skills', link: '/skills/messaging' }, { text: 'Calendar', link: '/skills/messaging/calendar' }, { text: 'Chat', link: '/skills/messaging/chat' }, { text: 'Email', link: '/skills/messaging/email' }, { text: 'Mail', link: '/skills/messaging/mail' }, { text: 'Notifications', link: '/skills/messaging/notifications' }, { text: 'Push', link: '/skills/messaging/push' }, { text: 'SMS', link: '/skills/messaging/sms' }, { text: 'Telephony', link: '/skills/messaging/telephony' }, { text: 'Newsletter', link: '/skills/messaging/newsletter' }, ], }, { text: 'Frontend', collapsed: true, items: [ { text: 'All frontend skills', link: '/skills/frontend' }, { text: 'Browser', link: '/skills/frontend/browser' }, { text: 'Composables', link: '/skills/frontend/composables' }, { text: 'ts-css', link: '/skills/frontend/ts-css' }, { text: 'Desktop', link: '/skills/frontend/desktop' }, { text: 'Mobile', link: '/skills/frontend/mobile' }, { text: 'stx', link: '/skills/frontend/stx' }, { text: 'UI', link: '/skills/frontend/ui' }, { text: 'Browser Extension', link: '/skills/frontend/browser-extension' }, { text: 'Charts', link: '/skills/frontend/charts' }, ], }, { text: 'Design', collapsed: true, items: [ { text: 'All design skills', link: '/skills/design' }, { text: 'Brand kit', link: '/skills/design/brandkit' }, { text: 'Design: brutalist', link: '/skills/design/design-brutalist' }, { text: 'Design: minimalist', link: '/skills/design/design-minimalist' }, { text: 'Design: full output', link: '/skills/design/design-output' }, { text: 'Design: soft', link: '/skills/design/design-soft' }, { text: 'Design taste', link: '/skills/design/design-taste' }, { text: 'Design taste (Codex)', link: '/skills/design/design-taste-codex' }, { text: 'Image to code', link: '/skills/design/image-to-code' }, { text: 'Image generation: mobile', link: '/skills/design/imagegen-mobile' }, { text: 'Image generation: web', link: '/skills/design/imagegen-web' }, { text: 'Redesign', link: '/skills/design/redesign' }, { text: 'Technical diagrams', link: '/skills/design/technical-diagrams' }, ], }, { text: 'Domain packages', collapsed: true, items: [ { text: 'All domain packages skills', link: '/skills/domain' }, { text: 'CMS', link: '/skills/domain/cms' }, { text: 'Commerce', link: '/skills/domain/commerce' }, { text: 'Dashboard', link: '/skills/domain/dashboard' }, { text: 'i18n', link: '/skills/domain/i18n' }, { text: 'Payments', link: '/skills/domain/payments' }, { text: 'Forms', link: '/skills/domain/forms' }, { text: 'Sites', link: '/skills/domain/sites' }, { text: 'HQ', link: '/skills/domain/hq' }, { text: 'Support', link: '/skills/domain/support' }, { text: 'Licensing', link: '/skills/domain/licensing' }, ], }, { text: 'Toolchain', collapsed: true, items: [ { text: 'All toolchain skills', link: '/skills/toolchain' }, { text: 'Analytics', link: '/skills/toolchain/analytics' }, { text: 'Buddy', link: '/skills/toolchain/buddy' }, { text: 'Build', link: '/skills/toolchain/build' }, { text: 'CLI', link: '/skills/toolchain/cli' }, { text: 'Cloud', link: '/skills/toolchain/cloud' }, { text: 'Deploy', link: '/skills/toolchain/deploy' }, { text: 'Development', link: '/skills/toolchain/development' }, { text: 'DNS', link: '/skills/toolchain/dns' }, { text: 'Docs', link: '/skills/toolchain/docs' }, { text: 'Git', link: '/skills/toolchain/git' }, { text: 'Lint', link: '/skills/toolchain/lint' }, { text: 'Plugins', link: '/skills/toolchain/plugins' }, { text: 'Registry', link: '/skills/toolchain/registry' }, { text: 'REPL', link: '/skills/toolchain/repl' }, { text: 'Scaffolding', link: '/skills/toolchain/scaffolding' }, { text: 'Server', link: '/skills/toolchain/server' }, { text: 'Shell', link: '/skills/toolchain/shell' }, { text: 'Testing', link: '/skills/toolchain/testing' }, { text: 'Tunnel', link: '/skills/toolchain/tunnel' }, { text: 'WHOIS', link: '/skills/toolchain/whois' }, ], }, { text: 'Platform', collapsed: true, items: [ { text: 'All platform skills', link: '/skills/platform' }, { text: 'Alias', link: '/skills/platform/alias' }, { text: 'Auto-imports', link: '/skills/platform/auto-imports' }, { text: 'Config', link: '/skills/platform/config' }, { text: 'Configuration', link: '/skills/platform/configuration' }, { text: 'Dependencies', link: '/skills/platform/dependencies' }, { text: 'Enums', link: '/skills/platform/enums' }, { text: 'Env', link: '/skills/platform/env' }, { text: 'Path', link: '/skills/platform/path' }, { text: 'Types', link: '/skills/platform/types' }, { text: 'Feature Flags', link: '/skills/platform/feature-flags' }, { text: 'Features', link: '/skills/platform/features' }, { text: 'Native', link: '/skills/platform/native' }, { text: 'Skills', link: '/skills/platform/skills' }, ], }, { text: 'Utilities', collapsed: true, items: [ { text: 'All utilities skills', link: '/skills/utilities' }, { text: 'Arrays', link: '/skills/utilities/arrays' }, { text: 'Collections', link: '/skills/utilities/collections' }, { text: 'DateTime', link: '/skills/utilities/datetime' }, { text: 'Objects', link: '/skills/utilities/objects' }, { text: 'Slug', link: '/skills/utilities/slug' }, { text: 'Strings', link: '/skills/utilities/strings' }, { text: 'Utils', link: '/skills/utilities/utils' }, { text: 'Audio', link: '/skills/utilities/audio' }, { text: 'Image', link: '/skills/utilities/image' }, { text: 'Video', link: '/skills/utilities/video' }, ], }, ], }, themeConfig: { logo: '/images/logos/logo-transparent.svg', footer: { message: 'Released under the MIT License.', copyright: 'Copyright 2024-present Stacks.js, Inc.', }, socialLinks: [ { icon: 'twitter', link: 'https://twitter.com/stacksjs' }, { icon: 'github', link: 'https://github.com/stacksjs/stacks' }, { icon: 'discord', link: 'https://stacksjs.com/discord' }, ], }, }, // SEO Configuration sitemap: { enabled: true, baseUrl: 'https://stacksjs.com/docs', }, robots: { enabled: true, }, } export default config