stacks-docs
Use when building or configuring documentation for a Stacks project - BunPress setup, doc generation, navigation, sidebar structure, or documentation meta/SEO. Covers @stacksjs/docs and config/docs.ts.
来源信息
- 仓库
- stacksjs/stacks
- 最近来源活动
- 2026年9月6日 16:59
- 检测到的 SKILL.md 语言
- 英语
- 星标
- 631
- 分支
- 20
安装方式
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
检查来源文件
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
正在显示 SKILL.md
SKILL.md
来源说明 · 只读预览- name
- stacks-docs
- description
- Use when building or configuring documentation for a Stacks project - BunPress setup, doc generation, navigation, sidebar structure, or documentation meta/SEO. Covers @stacksjs/docs and config/docs.ts.
- license
- MIT
- compatibility
- Bun >= 1.3.0, TypeScript
- allowed-tools
- Read Edit Write Bash Grep Glob
# Stacks Documentation
## Key Paths
- Core package: `storage/framework/core/docs/src/`
- Doc content: `docs/`
- Config: `config/docs.ts`
- Output: `storage/framework/docs/dist/`
- Package: `@stacksjs/docs`
## Source Files
```
docs/src/
├── index.ts # frameworkDefaults + merged docsConfig
└── meta.ts # CDN URLs, social links, PWA patterns
```
## API
```typescript
import { frameworkDefaults, docsConfig } from '@stacksjs/docs'
// Framework defaults
const frameworkDefaults: BunPressOptions = {
docsDir: path.projectPath('docs'),
outDir: path.frameworkPath('docs/dist'),
}
// Merged config (framework defaults + user config from config/docs.ts)
const docsConfig: BunPressOptions = { ...frameworkDefaults, ...userConfig }
```
## Meta Exports
```typescript
import { googleapis, gstatic, font, ogUrl, ogImage, github, releases, contributing, discord, twitter, pwaFontsRegex, pwaFontStylesRegex } from '@stacksjs/docs'
```
Social and CDN constants used in documentation templates and PWA configuration.
## Configuration (config/docs.ts)
```typescript
import type { BunPressOptions } from '@stacksjs/docs'
export default {
// Navigation
nav: [
{ text: 'Changelog', link: 'https://github.com/stacksjs/stacks/blob/main/CHANGELOG.md' },
{ text: 'Blog', link: 'https://updates.stacksjs.com' },
],
// Markdown settings
markdown: {
title: 'Stacks.js',
syntaxHighlighting: { theme: 'material-theme-palenight' },
toc: { depth: 2 },
},
// Sidebar structure
sidebar: {
'/prologue/': [/* ... */],
'/get-started/': [/* ... */],
'/basics/': [/* ... */],
'/digging-deeper/': [/* ... */],
'/cloud/': [/* ... */],
'/cli/': [/* ... */],
'/packages/': [/* ... */],
'/testing/': [/* ... */],
'/project/': [/* ... */],
},
// Theme
theme: {
logo: '/images/logos/logo-transparent.svg',
footer: { message: 'Released under the MIT License.', copyright: 'Copyright © 2025' },
socialLinks: [
{ icon: 'twitter', link: 'https://twitter.com/stacksjs' },
{ icon: 'github', link: 'https://github.com/stacksjs/stacks' },
{ icon: 'discord', link: 'https://stacksjs.com/discord' },
],
},
// SEO
sitemap: { hostname: 'https://stacksjs.com/docs' },
robotsTxt: { enabled: true },
} satisfies BunPressOptions
```
## CLI Commands
```bash
buddy dev:docs # Start docs dev server
buddy build:docs # Build documentation site
```
## Gotchas
- **BunPress, not VitePress** — the docs engine is BunPress (Stacks' own documentation tool)
- **Config merging** — `docsConfig` merges framework defaults with user config from `config/docs.ts`
- **Sidebar is section-based** — organized by URL prefix (prologue, get-started, basics, etc.)
- **SEO built-in** — sitemap and robots.txt generation enabled by default
- **Output goes to `storage/framework/docs/dist/`** — not the `docs/` source directory
在 GitHub 查看