mirror of
https://github.com/nicepkg/ai-workflow.git
synced 2026-11-18 18:04:23 +00:00
feat: add nextra docs
This commit is contained in:
@@ -0,0 +1,133 @@
|
||||
name: Deploy Website to Cloudflare Pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- 'website/**'
|
||||
- '.github/workflows/deploy-website.yml'
|
||||
pull_request:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- 'website/**'
|
||||
workflow_dispatch:
|
||||
|
||||
env:
|
||||
NODE_VERSION: '20'
|
||||
PNPM_VERSION: '10'
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: website
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup pnpm
|
||||
uses: pnpm/action-setup@v4
|
||||
with:
|
||||
version: ${{ env.PNPM_VERSION }}
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: ${{ env.NODE_VERSION }}
|
||||
cache: 'pnpm'
|
||||
cache-dependency-path: 'website/pnpm-lock.yaml'
|
||||
|
||||
- name: Get pnpm store directory
|
||||
shell: bash
|
||||
run: |
|
||||
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
||||
|
||||
- name: Setup pnpm cache
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: ${{ env.STORE_PATH }}
|
||||
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('website/pnpm-lock.yaml') }}
|
||||
restore-keys: |
|
||||
${{ runner.os }}-pnpm-store-
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
|
||||
- name: Build website
|
||||
run: pnpm build
|
||||
env:
|
||||
NEXT_PUBLIC_SITE_URL: https://ai-workflow.xiaominglab.com
|
||||
NEXT_PUBLIC_GIT_SHA: ${{ github.sha }}
|
||||
SKIP_ENV_VALIDATION: true
|
||||
|
||||
- name: Upload build artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: website-build
|
||||
path: website/out
|
||||
retention-days: 1
|
||||
|
||||
deploy:
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
permissions:
|
||||
contents: read
|
||||
deployments: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Download build artifact
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: website-build
|
||||
path: website/out
|
||||
|
||||
- name: Deploy to Cloudflare Pages
|
||||
uses: cloudflare/wrangler-action@v3
|
||||
with:
|
||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
||||
command: pages deploy website/out --project-name=ai-workflow --commit-dirty=true
|
||||
|
||||
# Preview deployment for pull requests
|
||||
preview:
|
||||
runs-on: ubuntu-latest
|
||||
needs: build
|
||||
if: github.event_name == 'pull_request'
|
||||
permissions:
|
||||
contents: read
|
||||
deployments: write
|
||||
pull-requests: write
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Download build artifact
|
||||
uses: actions/download-artifact@v4
|
||||
with:
|
||||
name: website-build
|
||||
path: website/out
|
||||
|
||||
- name: Deploy Preview to Cloudflare Pages
|
||||
id: deploy
|
||||
uses: cloudflare/wrangler-action@v3
|
||||
with:
|
||||
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
|
||||
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
|
||||
command: pages deploy website/out --project-name=ai-workflow --branch=${{ github.head_ref }} --commit-dirty=true
|
||||
|
||||
- name: Comment PR with preview URL
|
||||
uses: actions/github-script@v7
|
||||
with:
|
||||
script: |
|
||||
github.rest.issues.createComment({
|
||||
issue_number: context.issue.number,
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
body: `## 🚀 Preview Deployment Ready!\n\nPreview URL: ${{ steps.deploy.outputs.deployment-url }}\n\nThis preview will be available until the PR is closed.`
|
||||
})
|
||||
Generated
+3348
File diff suppressed because it is too large
Load Diff
@@ -9,8 +9,11 @@
|
||||
# When adding additional environment variables, the schema in "/src/env.js"
|
||||
# should be updated accordingly.
|
||||
|
||||
# port
|
||||
PORT=3003
|
||||
# Site URL (used for SEO and meta tags)
|
||||
NEXT_PUBLIC_SITE_URL=https://ai-workflow.xiaominglab.com
|
||||
|
||||
# deploy sha
|
||||
NEXT_PUBLIC_GIT_SHA=""
|
||||
# Git SHA (automatically set in CI)
|
||||
NEXT_PUBLIC_GIT_SHA=
|
||||
|
||||
# Skip environment validation during build
|
||||
SKIP_ENV_VALIDATION=false
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
export default {
|
||||
index: {
|
||||
title: "Home",
|
||||
type: "page",
|
||||
},
|
||||
docs: {
|
||||
title: "Documentation",
|
||||
type: "page",
|
||||
},
|
||||
workflows: {
|
||||
title: "Workflows",
|
||||
type: "page",
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,8 @@
|
||||
export default {
|
||||
"getting-started": "Getting Started",
|
||||
installation: "Installation",
|
||||
"supported-tools": "Supported AI Tools",
|
||||
"creating-skills": "Creating Skills",
|
||||
"creating-workflows": "Creating Workflows",
|
||||
contributing: "Contributing",
|
||||
};
|
||||
@@ -0,0 +1,123 @@
|
||||
---
|
||||
title: Contributing
|
||||
description: How to contribute to AI Workflow
|
||||
---
|
||||
|
||||
# Contributing
|
||||
|
||||
We welcome contributions to AI Workflow! This guide explains how to contribute.
|
||||
|
||||
## Ways to Contribute
|
||||
|
||||
- **New Skills** - Create useful skills for the community
|
||||
- **New Workflows** - Curate skill collections for specific use cases
|
||||
- **Bug Fixes** - Fix issues in existing skills or documentation
|
||||
- **Documentation** - Improve guides and examples
|
||||
- **Translations** - Help translate documentation
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Fork the repository on GitHub
|
||||
2. Clone your fork:
|
||||
```bash
|
||||
git clone https://github.com/your-username/ai-workflow.git
|
||||
cd ai-workflow
|
||||
```
|
||||
|
||||
3. Create a branch for your contribution:
|
||||
```bash
|
||||
git checkout -b feature/my-contribution
|
||||
```
|
||||
|
||||
## Contributing Skills
|
||||
|
||||
### 1. Create Your Skill
|
||||
|
||||
```bash
|
||||
mkdir -p workflows/your-workflow/.claude/skills/your-skill
|
||||
```
|
||||
|
||||
### 2. Write SKILL.md
|
||||
|
||||
Follow the [Creating Skills](/docs/creating-skills) guide to write your skill definition.
|
||||
|
||||
### 3. Test Your Skill
|
||||
|
||||
Test the skill with multiple AI assistants to ensure compatibility.
|
||||
|
||||
### 4. Submit a Pull Request
|
||||
|
||||
Push your changes and open a pull request:
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "feat: add your-skill to your-workflow"
|
||||
git push origin feature/my-contribution
|
||||
```
|
||||
|
||||
## Contributing Workflows
|
||||
|
||||
### 1. Create Workflow Structure
|
||||
|
||||
Use the workflow creator script:
|
||||
|
||||
```bash
|
||||
python .claude/skills/workflow-creator/scripts/create_workflow.py my-workflow --path ./workflows
|
||||
```
|
||||
|
||||
### 2. Add Skills
|
||||
|
||||
Add at least 10 useful skills to your workflow.
|
||||
|
||||
### 3. Write Documentation
|
||||
|
||||
- `README.md` - User-facing documentation
|
||||
- `AGENTS.md` - AI instructions
|
||||
|
||||
### 4. Verify Symlinks
|
||||
|
||||
Ensure all 13 AI tool symlinks are correctly created.
|
||||
|
||||
## Pull Request Guidelines
|
||||
|
||||
### Checklist
|
||||
|
||||
For new workflows:
|
||||
- [ ] README.md included
|
||||
- [ ] README_cn.md included (Chinese documentation)
|
||||
- [ ] AGENTS.md included
|
||||
- [ ] At least 10 skills included
|
||||
- [ ] All symlinks created
|
||||
|
||||
For new skills:
|
||||
- [ ] SKILL.md has valid frontmatter
|
||||
- [ ] Clear, actionable instructions
|
||||
- [ ] Examples included
|
||||
- [ ] Tested with at least one AI tool
|
||||
|
||||
### Commit Messages
|
||||
|
||||
Use conventional commits:
|
||||
|
||||
```
|
||||
feat: add new skill for X
|
||||
fix: correct typo in skill instructions
|
||||
docs: improve getting started guide
|
||||
```
|
||||
|
||||
### Code Review
|
||||
|
||||
- All PRs require review before merging
|
||||
- Address feedback promptly
|
||||
- Keep discussions constructive
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
Please read our [Code of Conduct](https://github.com/nicepkg/ai-workflow/blob/main/CODE_OF_CONDUCT.md) before contributing.
|
||||
|
||||
## Questions?
|
||||
|
||||
- Open an issue on GitHub
|
||||
- Join discussions in the repository
|
||||
|
||||
Thank you for contributing!
|
||||
@@ -0,0 +1,171 @@
|
||||
---
|
||||
title: Creating Skills
|
||||
description: How to create your own AI skills
|
||||
---
|
||||
|
||||
# Creating Skills
|
||||
|
||||
Skills are reusable instructions that extend your AI assistant's capabilities. This guide shows you how to create your own skills.
|
||||
|
||||
## Skill Structure
|
||||
|
||||
Each skill is a folder containing at least a `SKILL.md` file:
|
||||
|
||||
```
|
||||
skill-name/
|
||||
├── SKILL.md # Required: Skill definition
|
||||
├── scripts/ # Optional: Helper scripts
|
||||
│ └── helper.py
|
||||
├── templates/ # Optional: File templates
|
||||
│ └── template.md
|
||||
└── references/ # Optional: Reference materials
|
||||
└── guide.md
|
||||
```
|
||||
|
||||
## SKILL.md Format
|
||||
|
||||
The `SKILL.md` file defines your skill:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: my-skill
|
||||
description: A brief description of what this skill does
|
||||
triggers:
|
||||
- "keyword1"
|
||||
- "keyword2"
|
||||
---
|
||||
|
||||
# My Skill
|
||||
|
||||
## Overview
|
||||
Explain what this skill does and when to use it.
|
||||
|
||||
## Instructions
|
||||
Step-by-step instructions for the AI to follow.
|
||||
|
||||
### Step 1: Analyze
|
||||
Describe the first step...
|
||||
|
||||
### Step 2: Execute
|
||||
Describe the second step...
|
||||
|
||||
## Examples
|
||||
|
||||
### Example 1
|
||||
Show an example input and expected output.
|
||||
|
||||
## Notes
|
||||
Any additional context or warnings.
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Clear Instructions
|
||||
Write instructions that are:
|
||||
- Specific and actionable
|
||||
- Broken into numbered steps
|
||||
- Include examples where helpful
|
||||
|
||||
### 2. Appropriate Scope
|
||||
Each skill should:
|
||||
- Do one thing well
|
||||
- Be reusable across projects
|
||||
- Not overlap with other skills
|
||||
|
||||
### 3. Good Naming
|
||||
- Use lowercase with hyphens: `my-skill-name`
|
||||
- Be descriptive but concise
|
||||
- Avoid generic names like `helper` or `utils`
|
||||
|
||||
## Adding to a Workflow
|
||||
|
||||
1. Create your skill folder in `.claude/skills/`:
|
||||
|
||||
```bash
|
||||
mkdir -p .claude/skills/my-skill
|
||||
```
|
||||
|
||||
2. Create the `SKILL.md` file:
|
||||
|
||||
```bash
|
||||
touch .claude/skills/my-skill/SKILL.md
|
||||
```
|
||||
|
||||
3. Edit `SKILL.md` with your skill definition
|
||||
|
||||
4. Test the skill with your AI assistant
|
||||
|
||||
## Example Skill
|
||||
|
||||
Here's a complete example of a documentation skill:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: write-docs
|
||||
description: Generate documentation for code
|
||||
triggers:
|
||||
- "document this"
|
||||
- "write docs"
|
||||
- "add documentation"
|
||||
---
|
||||
|
||||
# Documentation Generator
|
||||
|
||||
## Overview
|
||||
Generates comprehensive documentation for code files, functions, and modules.
|
||||
|
||||
## Instructions
|
||||
|
||||
### Step 1: Analyze the Code
|
||||
- Identify the purpose of the code
|
||||
- Note all public functions and classes
|
||||
- Understand the input/output types
|
||||
|
||||
### Step 2: Generate Documentation
|
||||
- Write a module-level docstring
|
||||
- Document each public function
|
||||
- Include parameter types and return values
|
||||
- Add usage examples
|
||||
|
||||
### Step 3: Review
|
||||
- Ensure documentation is accurate
|
||||
- Check for completeness
|
||||
- Verify examples work
|
||||
|
||||
## Output Format
|
||||
Use the project's existing documentation style. Default to:
|
||||
- JSDoc for JavaScript/TypeScript
|
||||
- Docstrings for Python
|
||||
- XML comments for C#
|
||||
|
||||
## Example
|
||||
|
||||
Input:
|
||||
\`\`\`python
|
||||
def calculate_total(items, tax_rate):
|
||||
subtotal = sum(item.price for item in items)
|
||||
return subtotal * (1 + tax_rate)
|
||||
\`\`\`
|
||||
|
||||
Output:
|
||||
\`\`\`python
|
||||
def calculate_total(items: list[Item], tax_rate: float) -> float:
|
||||
"""
|
||||
Calculate the total price including tax.
|
||||
|
||||
Args:
|
||||
items: List of items to calculate total for
|
||||
tax_rate: Tax rate as a decimal (e.g., 0.08 for 8%)
|
||||
|
||||
Returns:
|
||||
Total price including tax
|
||||
|
||||
Example:
|
||||
>>> items = [Item(price=10), Item(price=20)]
|
||||
>>> calculate_total(items, 0.08)
|
||||
32.4
|
||||
"""
|
||||
subtotal = sum(item.price for item in items)
|
||||
return subtotal * (1 + tax_rate)
|
||||
\`\`\`
|
||||
```
|
||||
@@ -0,0 +1,168 @@
|
||||
---
|
||||
title: Creating Workflows
|
||||
description: How to create custom workflows with curated skills
|
||||
---
|
||||
|
||||
# Creating Workflows
|
||||
|
||||
Workflows are curated collections of skills designed for specific use cases. This guide shows you how to create your own workflows.
|
||||
|
||||
## Method 1: AI-Assisted Creation (Recommended)
|
||||
|
||||
The easiest way to create a workflow is to let your AI assistant do it for you.
|
||||
|
||||
### Step 1: Clone the Repository
|
||||
|
||||
```bash
|
||||
git clone https://github.com/nicepkg/ai-workflow.git
|
||||
cd ai-workflow
|
||||
```
|
||||
|
||||
### Step 2: Open with AI Coding Assistant
|
||||
|
||||
Open the project with any AI tool that supports skills:
|
||||
- **Claude Code**: `claude` in terminal
|
||||
- **Cursor**: Open folder in Cursor
|
||||
- **Codex**: `codex` in terminal
|
||||
- **OpenCode**: `opencode` in terminal
|
||||
|
||||
### Step 3: Ask AI to Create Your Workflow
|
||||
|
||||
Simply describe what you need:
|
||||
|
||||
```
|
||||
"Create a researcher workflow for academic paper writing"
|
||||
"Create a devops workflow for kubernetes management"
|
||||
"Create a data-scientist workflow for ML projects"
|
||||
```
|
||||
|
||||
The AI will automatically:
|
||||
1. Create the workflow directory structure
|
||||
2. Find and download relevant skills from skill sources
|
||||
3. Create custom skills as needed
|
||||
4. Generate documentation (README.md, AGENTS.md)
|
||||
5. Set up symlinks for all AI tools
|
||||
|
||||
## Method 2: Manual Creation
|
||||
|
||||
For full control over the workflow structure.
|
||||
|
||||
### Workflow Structure
|
||||
|
||||
```
|
||||
workflows/my-workflow/
|
||||
├── README.md # User documentation
|
||||
├── AGENTS.md # AI instructions
|
||||
├── .claude/
|
||||
│ ├── settings.json
|
||||
│ └── skills/ # Primary skill storage
|
||||
│ ├── skill-1/
|
||||
│ │ └── SKILL.md
|
||||
│ └── skill-2/
|
||||
│ └── SKILL.md
|
||||
├── .cursor/
|
||||
│ └── skills -> ../.claude/skills
|
||||
├── .codex/
|
||||
│ └── skills -> ../.claude/skills
|
||||
└── ... (other AI tool symlinks)
|
||||
```
|
||||
|
||||
### Create Directory Structure
|
||||
|
||||
```bash
|
||||
# Create workflow directory
|
||||
mkdir -p workflows/my-workflow/.claude/skills
|
||||
|
||||
# Create settings file
|
||||
echo '{"permissions": {}}' > workflows/my-workflow/.claude/settings.json
|
||||
|
||||
# Create documentation files
|
||||
touch workflows/my-workflow/README.md
|
||||
touch workflows/my-workflow/AGENTS.md
|
||||
```
|
||||
|
||||
### Create Symlinks
|
||||
|
||||
```bash
|
||||
cd workflows/my-workflow
|
||||
|
||||
# Create directories for each AI tool
|
||||
mkdir -p .cursor .codex .opencode .agents .kilocode .roo .goose .gemini .agent .github .factory .windsurf
|
||||
|
||||
# Create symlinks
|
||||
ln -s ../.claude/skills .cursor/skills
|
||||
ln -s ../.claude/skills .codex/skills
|
||||
ln -s ../.claude/skills .opencode/skill
|
||||
ln -s ../.claude/skills .agents/skills
|
||||
ln -s ../.claude/skills .kilocode/skills
|
||||
ln -s ../.claude/skills .roo/skills
|
||||
ln -s ../.claude/skills .goose/skills
|
||||
ln -s ../.claude/skills .gemini/skills
|
||||
ln -s ../.claude/skills .agent/skills
|
||||
ln -s ../.claude/skills .github/skills
|
||||
ln -s ../.claude/skills .factory/skills
|
||||
ln -s ../.claude/skills .windsurf/skills
|
||||
ln -s .claude/skills skills
|
||||
```
|
||||
|
||||
## Adding Skills
|
||||
|
||||
### Option 1: Download from Skill Sources
|
||||
|
||||
Skills can be sourced from:
|
||||
- [Anthropic Official Skills](https://github.com/anthropics/skills)
|
||||
- [vercel-labs/agent-skills](https://github.com/vercel-labs/agent-skills)
|
||||
- [ComposioHQ/awesome-claude-skills](https://github.com/ComposioHQ/awesome-claude-skills)
|
||||
- [skillhub.club](https://www.skillhub.club) - 1000+ skills collection
|
||||
|
||||
### Option 2: Create Custom Skills
|
||||
|
||||
Create a new skill in `.claude/skills/`:
|
||||
|
||||
```bash
|
||||
mkdir -p .claude/skills/my-skill
|
||||
```
|
||||
|
||||
Create `SKILL.md`:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: my-skill
|
||||
description: What this skill does and when AI should use it
|
||||
---
|
||||
|
||||
# My Skill
|
||||
|
||||
Instructions for the AI to follow...
|
||||
```
|
||||
|
||||
See [Creating Skills](/docs/creating-skills) for detailed guidance.
|
||||
|
||||
## Documentation
|
||||
|
||||
### README.md
|
||||
|
||||
Should include:
|
||||
- Workflow purpose and target users
|
||||
- List of included skills with descriptions
|
||||
- Installation command
|
||||
- Usage examples
|
||||
|
||||
### AGENTS.md
|
||||
|
||||
Provides context for AI assistants:
|
||||
- Workflow overview
|
||||
- Available skills and when to use them
|
||||
- Output standards and best practices
|
||||
|
||||
## Publishing Your Workflow
|
||||
|
||||
1. Fork the [ai-workflow repository](https://github.com/nicepkg/ai-workflow)
|
||||
2. Add your workflow to the `workflows/` directory
|
||||
3. Update the main README.md with your workflow
|
||||
4. Submit a pull request
|
||||
|
||||
Your workflow will be installable via:
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/your-workflow
|
||||
```
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: Getting Started
|
||||
description: Learn how to use AI Workflow with your favorite AI coding assistant
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
|
||||
AI Workflow provides pre-configured skill sets for AI coding assistants. This guide will help you get started quickly.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Node.js 18+ installed
|
||||
- An AI coding assistant (Claude Code, Cursor, Copilot, etc.)
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Install a Complete Workflow (Recommended)
|
||||
|
||||
```bash
|
||||
# Pick your workflow and run ONE command:
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow
|
||||
|
||||
# That's it! Skills are now active in your AI assistant.
|
||||
```
|
||||
|
||||
### Available Workflows
|
||||
|
||||
| Workflow | For Who | Skills | Install |
|
||||
|:---------|:--------|:------:|:--------|
|
||||
| Content Creator | Bloggers, Writers, SEO Specialists | 32 | `npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow` |
|
||||
| Marketing Pro | Digital Marketers, Growth Hackers, PMMs | 38 | `npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow` |
|
||||
| Video Creator | YouTubers, TikTokers, Video Producers | 29 | `npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow` |
|
||||
| Stock Trader | Traders, Investors (US/CN/HK/TW Markets) | 29 | `npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow` |
|
||||
| Product Manager | PMs, Product Owners, Head of Product | 23 | `npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow` |
|
||||
| Talk to Slidev | Keynote Speakers, Tech Presenters, Educators | 18 | `npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow` |
|
||||
|
||||
### Install Individual Skills
|
||||
|
||||
```bash
|
||||
# Install just what you need
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow --skill a-share-analysis
|
||||
|
||||
# List available skills first
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow --list
|
||||
```
|
||||
|
||||
### Advanced Options
|
||||
|
||||
```bash
|
||||
# Install globally (available in all projects)
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow --global
|
||||
|
||||
# Install to specific AI tools only
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow -a claude-code -a cursor
|
||||
|
||||
# Non-interactive mode (for CI/CD)
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow -y
|
||||
```
|
||||
|
||||
## Verify Installation
|
||||
|
||||
After installation, the skills should be automatically available in your AI assistant. Try using a skill by mentioning its name or purpose in your conversation.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Installation Options](/docs/installation) - More installation methods
|
||||
- [Supported Tools](/docs/supported-tools) - Full list of supported AI tools
|
||||
- [Creating Skills](/docs/creating-skills) - Create your own skills
|
||||
@@ -0,0 +1,148 @@
|
||||
---
|
||||
title: Installation
|
||||
description: Different ways to install and use AI Workflow
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
There are several ways to use AI Workflow in your projects.
|
||||
|
||||
## Method 1: npx add-skill (Recommended)
|
||||
|
||||
The easiest way to install skills. No setup required.
|
||||
|
||||
### Install a Complete Workflow
|
||||
|
||||
```bash
|
||||
# Content creators, bloggers, writers
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow
|
||||
|
||||
# Digital marketers, growth hackers
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow
|
||||
|
||||
# YouTubers, video producers
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow
|
||||
|
||||
# Stock traders, investors
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow
|
||||
|
||||
# Product managers
|
||||
npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow
|
||||
|
||||
# Presentation creators
|
||||
npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow
|
||||
```
|
||||
|
||||
### Install Individual Skills
|
||||
|
||||
```bash
|
||||
# List available skills in a workflow
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow --list
|
||||
|
||||
# Install a specific skill
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow --skill a-share-analysis
|
||||
```
|
||||
|
||||
### Installation Options
|
||||
|
||||
```bash
|
||||
# Install globally (available in all projects)
|
||||
npx add-skill <workflow> --global
|
||||
|
||||
# Install to specific AI tools only
|
||||
npx add-skill <workflow> -a claude-code -a cursor
|
||||
|
||||
# Non-interactive mode (for CI/CD)
|
||||
npx add-skill <workflow> -y
|
||||
|
||||
# Specify installation directory
|
||||
npx add-skill <workflow> --path ./my-project
|
||||
```
|
||||
|
||||
## Method 2: Manual Installation
|
||||
|
||||
For advanced users who want more control.
|
||||
|
||||
### Clone and Copy
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/nicepkg/ai-workflow.git
|
||||
|
||||
# Copy a workflow's skills to your project
|
||||
cp -r ai-workflow/workflows/content-creator-workflow/.claude/skills your-project/.claude/
|
||||
```
|
||||
|
||||
### Create Symlinks for Other AI Tools
|
||||
|
||||
```bash
|
||||
cd your-project
|
||||
|
||||
# Create directories
|
||||
mkdir -p .cursor .codex .opencode
|
||||
|
||||
# Create symlinks
|
||||
ln -s ../.claude/skills .cursor/skills
|
||||
ln -s ../.claude/skills .codex/skills
|
||||
ln -s ../.claude/skills .opencode/skill
|
||||
```
|
||||
|
||||
## Directory Structure
|
||||
|
||||
After installation, your project will have:
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── .claude/
|
||||
│ └── skills/ # Primary skill storage
|
||||
│ ├── skill-1/
|
||||
│ │ └── SKILL.md
|
||||
│ └── skill-2/
|
||||
│ └── SKILL.md
|
||||
├── .cursor/
|
||||
│ └── skills -> ../.claude/skills
|
||||
├── .codex/
|
||||
│ └── skills -> ../.claude/skills
|
||||
└── ... (other AI tool symlinks)
|
||||
```
|
||||
|
||||
## Global vs Project Installation
|
||||
|
||||
| Type | Location | Use Case |
|
||||
|:-----|:---------|:---------|
|
||||
| Project | `.claude/skills/` | Skills specific to one project |
|
||||
| Global | `~/.claude/skills/` | Skills available in all projects |
|
||||
|
||||
```bash
|
||||
# Project installation (default)
|
||||
npx add-skill <workflow>
|
||||
|
||||
# Global installation
|
||||
npx add-skill <workflow> --global
|
||||
```
|
||||
|
||||
## Updating Skills
|
||||
|
||||
```bash
|
||||
# Reinstall to get latest version
|
||||
npx add-skill <workflow>
|
||||
|
||||
# Or pull latest and copy manually
|
||||
cd ai-workflow
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Skills not loading?
|
||||
|
||||
1. Check if skills are in the correct directory for your AI tool
|
||||
2. Restart your AI assistant
|
||||
3. Verify the `SKILL.md` files exist
|
||||
|
||||
### Permission errors?
|
||||
|
||||
```bash
|
||||
# Fix permissions on Unix/Mac
|
||||
chmod -R 755 .claude/skills
|
||||
```
|
||||
@@ -0,0 +1,89 @@
|
||||
---
|
||||
title: Supported AI Tools
|
||||
description: Full list of AI coding assistants supported by AI Workflow
|
||||
---
|
||||
|
||||
# Supported AI Tools
|
||||
|
||||
AI Workflow supports **14+ AI coding assistants** out of the box. All tools share the same skills through a symlink architecture.
|
||||
|
||||
## Architecture
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── .claude/
|
||||
│ └── skills/ ← Primary storage (real files)
|
||||
├── .cursor/
|
||||
│ └── skills ← Symlink → ../.claude/skills
|
||||
├── .codex/
|
||||
│ └── skills ← Symlink → ../.claude/skills
|
||||
├── .opencode/
|
||||
│ └── skill ← Symlink → ../.claude/skills
|
||||
└── ... (other symlinks)
|
||||
```
|
||||
|
||||
## Supported Tools
|
||||
|
||||
| AI Tool | Project Path | Global Path | Notes |
|
||||
|:--------|:-------------|:------------|:------|
|
||||
| **Claude Code** | `.claude/skills/` | `~/.claude/skills/` | Primary storage |
|
||||
| **Cursor** | `.cursor/skills/` | `~/.cursor/skills/` | Symlink |
|
||||
| **GitHub Copilot** | `.github/skills/` | `~/.copilot/skills/` | Symlink |
|
||||
| **Codex** | `.codex/skills/` | `~/.codex/skills/` | Symlink |
|
||||
| **OpenCode** | `.opencode/skill/` | `~/.config/opencode/skill/` | Symlink (singular) |
|
||||
| **Amp** | `.agents/skills/` | `~/.config/agents/skills/` | Symlink |
|
||||
| **Roo Code** | `.roo/skills/` | `~/.roo/skills/` | Symlink |
|
||||
| **Kilo Code** | `.kilocode/skills/` | `~/.kilocode/skills/` | Symlink |
|
||||
| **Goose** | `.goose/skills/` | `~/.config/goose/skills/` | Symlink |
|
||||
| **Gemini CLI** | `.gemini/skills/` | `~/.gemini/skills/` | Symlink |
|
||||
| **Antigravity** | `.agent/skills/` | `~/.gemini/antigravity/skills/` | Symlink |
|
||||
| **Clawdbot** | `skills/` | `~/.clawdbot/skills/` | Root-level symlink |
|
||||
| **Droid** | `.factory/skills/` | `~/.factory/skills/` | Symlink |
|
||||
| **Windsurf** | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` | Symlink |
|
||||
|
||||
## Creating Symlinks
|
||||
|
||||
Use the provided script to create all symlinks automatically:
|
||||
|
||||
```bash
|
||||
python scripts/create_workflow.py my-workflow --path ./workflows
|
||||
```
|
||||
|
||||
Or create them manually:
|
||||
|
||||
```bash
|
||||
# Create directories
|
||||
mkdir -p .cursor .codex .opencode .agents .kilocode .roo .goose .gemini .agent .github .factory .windsurf
|
||||
|
||||
# Create symlinks
|
||||
ln -s ../.claude/skills .cursor/skills
|
||||
ln -s ../.claude/skills .codex/skills
|
||||
ln -s ../.claude/skills .opencode/skill
|
||||
ln -s ../.claude/skills .agents/skills
|
||||
ln -s ../.claude/skills .kilocode/skills
|
||||
ln -s ../.claude/skills .roo/skills
|
||||
ln -s ../.claude/skills .goose/skills
|
||||
ln -s ../.claude/skills .gemini/skills
|
||||
ln -s ../.claude/skills .agent/skills
|
||||
ln -s ../.claude/skills .github/skills
|
||||
ln -s ../.claude/skills .factory/skills
|
||||
ln -s ../.claude/skills .windsurf/skills
|
||||
ln -s .claude/skills skills
|
||||
```
|
||||
|
||||
## Tool-Specific Notes
|
||||
|
||||
### OpenCode
|
||||
OpenCode uses `skill` (singular) instead of `skills`:
|
||||
```bash
|
||||
ln -s ../.claude/skills .opencode/skill
|
||||
```
|
||||
|
||||
### Clawdbot
|
||||
Clawdbot looks for skills at the root level:
|
||||
```bash
|
||||
ln -s .claude/skills skills
|
||||
```
|
||||
|
||||
### GitHub Copilot
|
||||
GitHub Copilot shares the `.github/` directory with GitHub workflows. The `skills/` subdirectory won't conflict with existing GitHub configurations.
|
||||
@@ -0,0 +1,59 @@
|
||||
# AI Workflow
|
||||
|
||||
**Supercharge Your AI Coding Assistant with Pre-built Skill Collections**
|
||||
|
||||
Stop teaching your AI assistant the same things over and over. One command. 170+ professional skills. Instant productivity boost.
|
||||
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
# Pick your workflow and run ONE command:
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow
|
||||
|
||||
# That's it! Skills are now active in your AI assistant.
|
||||
```
|
||||
|
||||
## Why AI Workflow?
|
||||
|
||||
| Before | After |
|
||||
|--------|-------|
|
||||
| "Write me a blog post..." then explain SEO, formatting, tone every time | AI already knows your content strategy, SEO rules, and brand voice |
|
||||
| Manually teaching AI about stock analysis concepts | AI performs professional technical & fundamental analysis instantly |
|
||||
| Repeating marketing frameworks and templates | AI generates on-brand copy with proper UTM tracking |
|
||||
| Copy-pasting prompts from notes | Skills auto-activate based on your project |
|
||||
|
||||
**AI Workflow** = Pre-configured skill sets that make your AI assistant an expert in specific domains.
|
||||
|
||||
## Available Workflows
|
||||
|
||||
| Workflow | For Who | Skills | Install |
|
||||
|:---------|:--------|:------:|:--------|
|
||||
| [Content Creator](/workflows/content-creator) | Bloggers, Writers, SEO Specialists | 32 | `npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow` |
|
||||
| [Marketing Pro](/workflows/marketing-pro) | Digital Marketers, Growth Hackers, PMMs | 38 | `npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow` |
|
||||
| [Video Creator](/workflows/video-creator) | YouTubers, TikTokers, Video Producers | 29 | `npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow` |
|
||||
| [Stock Trader](/workflows/stock-trader) | Traders, Investors (US/CN/HK/TW Markets) | 29 | `npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow` |
|
||||
| [Product Manager](/workflows/product-manager) | PMs, Product Owners, Head of Product | 23 | `npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow` |
|
||||
| [Talk to Slidev](/workflows/talk-to-slidev) | Keynote Speakers, Tech Presenters, Educators | 18 | `npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow` |
|
||||
|
||||
## Supported AI Tools
|
||||
|
||||
Works with **14+ AI coding assistants** out of the box:
|
||||
|
||||
| AI Tool | Project Path | Global Path |
|
||||
|:--------|:-------------|:------------|
|
||||
| Claude Code | `.claude/skills/` | `~/.claude/skills/` |
|
||||
| Cursor | `.cursor/skills/` | `~/.cursor/skills/` |
|
||||
| GitHub Copilot | `.github/skills/` | `~/.copilot/skills/` |
|
||||
| Codex | `.codex/skills/` | `~/.codex/skills/` |
|
||||
| OpenCode | `.opencode/skill/` | `~/.config/opencode/skill/` |
|
||||
| Amp | `.agents/skills/` | `~/.config/agents/skills/` |
|
||||
| Roo Code | `.roo/skills/` | `~/.roo/skills/` |
|
||||
| Kilo Code | `.kilocode/skills/` | `~/.kilocode/skills/` |
|
||||
| Goose | `.goose/skills/` | `~/.config/goose/skills/` |
|
||||
| Gemini CLI | `.gemini/skills/` | `~/.gemini/skills/` |
|
||||
| Antigravity | `.agent/skills/` | `~/.gemini/antigravity/skills/` |
|
||||
| Clawdbot | `skills/` | `~/.clawdbot/skills/` |
|
||||
| Droid | `.factory/skills/` | `~/.factory/skills/` |
|
||||
| Windsurf | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` |
|
||||
|
||||
[Get Started](/docs/getting-started) | [View on GitHub](https://github.com/nicepkg/ai-workflow)
|
||||
@@ -0,0 +1,9 @@
|
||||
export default {
|
||||
index: "Overview",
|
||||
"content-creator": "Content Creator",
|
||||
"marketing-pro": "Marketing Pro",
|
||||
"video-creator": "Video Creator",
|
||||
"stock-trader": "Stock Trader",
|
||||
"product-manager": "Product Manager",
|
||||
"talk-to-slidev": "Talk to Slidev",
|
||||
};
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: Content Creator Workflow
|
||||
description: Pre-configured skills for bloggers, writers, and content creators
|
||||
---
|
||||
|
||||
# Content Creator Workflow
|
||||
|
||||
A curated collection of 32 skills designed for content creators, bloggers, and writers.
|
||||
|
||||
## Target Users
|
||||
|
||||
- Bloggers and article writers
|
||||
- Technical documentation authors
|
||||
- SEO specialists
|
||||
- Newsletter publishers
|
||||
- Social media content creators
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow
|
||||
```
|
||||
|
||||
## Included Skills
|
||||
|
||||
`weak-signal-synthesizer` `content-trend-researcher` `competitive-ads-extractor` `twitter-reader` `article-extractor` `youtube-processor` `youtube-transcript` `content-research` `content-brief-generator` `content-brief` `skill-navigator` `blog-post-writer` `content-research-writer` `newsletter-coach` `fact-checker` `hook-stack-evaluator` `email-subject-line-optimizer` `ai-slop-detector` `content-repurposer` `social-repurposer` `social-media` `linkedin-announcement-generator` `podcast-content-suite` `pre-publish-post-assistant` `seo-wordpress-manager` `gsc-assistant` `astro-cta-injector` `nano-banana` `canvas-design` `docx` `pdf`
|
||||
|
||||
## Key Capabilities
|
||||
|
||||
- **Content Research** - Trend analysis, competitive research, topic ideation
|
||||
- **Writing Assistance** - Blog posts, newsletters, social media content
|
||||
- **SEO Optimization** - WordPress SEO, Google Search Console integration
|
||||
- **Content Repurposing** - Transform content across platforms
|
||||
- **Quality Assurance** - Fact checking, AI content detection
|
||||
|
||||
## Advanced Options
|
||||
|
||||
```bash
|
||||
# Install globally
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow --global
|
||||
|
||||
# Install specific skill
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow --skill blog-post-writer
|
||||
|
||||
# List all skills
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow --list
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
- [View on GitHub](https://github.com/nicepkg/ai-workflow/tree/main/workflows/content-creator-workflow)
|
||||
- [Contributing](/docs/contributing)
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: Workflows Overview
|
||||
description: Browse pre-configured AI workflows for different use cases
|
||||
---
|
||||
|
||||
# Workflows
|
||||
|
||||
AI Workflow provides curated skill collections for different professional needs. Each workflow includes carefully selected skills optimized for specific use cases.
|
||||
|
||||
## Available Workflows
|
||||
|
||||
| Workflow | For Who | Skills | Install |
|
||||
|:---------|:--------|:------:|:--------|
|
||||
| [Content Creator](/workflows/content-creator) | Bloggers, Writers, SEO Specialists | 32 | `npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow` |
|
||||
| [Marketing Pro](/workflows/marketing-pro) | Digital Marketers, Growth Hackers, PMMs | 38 | `npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow` |
|
||||
| [Video Creator](/workflows/video-creator) | YouTubers, TikTokers, Video Producers | 29 | `npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow` |
|
||||
| [Stock Trader](/workflows/stock-trader) | Traders, Investors (US/CN/HK/TW Markets) | 29 | `npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow` |
|
||||
| [Product Manager](/workflows/product-manager) | PMs, Product Owners, Head of Product | 23 | `npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow` |
|
||||
| [Talk to Slidev](/workflows/talk-to-slidev) | Keynote Speakers, Tech Presenters, Educators | 18 | `npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow` |
|
||||
|
||||
## Quick Install
|
||||
|
||||
```bash
|
||||
# Pick your workflow and run ONE command:
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow
|
||||
|
||||
# That's it! Skills are now active in your AI assistant.
|
||||
```
|
||||
|
||||
## Advanced Options
|
||||
|
||||
```bash
|
||||
# Install globally (available in all projects)
|
||||
npx add-skill <workflow> --global
|
||||
|
||||
# Install specific skills only
|
||||
npx add-skill <workflow> --skill skill-name
|
||||
|
||||
# List available skills
|
||||
npx add-skill <workflow> --list
|
||||
```
|
||||
|
||||
## Creating Custom Workflows
|
||||
|
||||
Need a workflow for your specific use case? See [Creating Workflows](/docs/creating-workflows) to build your own.
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: Marketing Pro Workflow
|
||||
description: Pre-configured skills for marketing professionals and campaign managers
|
||||
---
|
||||
|
||||
# Marketing Pro Workflow
|
||||
|
||||
A comprehensive collection of 38 skills for marketing professionals, campaign managers, and growth teams.
|
||||
|
||||
## Target Users
|
||||
|
||||
- Digital marketers
|
||||
- Growth hackers
|
||||
- Product marketing managers (PMMs)
|
||||
- Campaign strategists
|
||||
- Brand managers
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow
|
||||
```
|
||||
|
||||
## Included Skills
|
||||
|
||||
`skill-navigator` `marketing` `buyer-persona-generator` `Go-to-Market-Planner` `prd-v09-gtm-strategy` `marketing-strategy-pmm` `pricing-strategist` `competitor-price-tracker` `competitive-ads-extractor` `copy` `ad-copy-generator` `content-optimizer` `content-brief` `landing-page` `landing-page-copywriter` `ui-ux-audit` `running-marketing-campaigns` `utm-builder` `qr-code-generator` `email-template-generator` `cold-email-sequence-generator` `cold-outreach-generator` `personalization-at-scale` `lead-research-assistant` `funnel-analysis` `analytics-interpretation` `technical-launch-planner` `launch-gtm-execution` `executive-dashboard-generator` `product-analytics` `roi-analyzer` `social-media-analyzer` `marketing-demand-acquisition` `seo-optimizer` `serp-analysis` `keyword-cluster-builder` `linkedin-post-optimizer` `social-repurposer`
|
||||
|
||||
## Key Capabilities
|
||||
|
||||
- **Strategy** - Go-to-market planning, buyer personas, pricing strategy
|
||||
- **Campaign Management** - UTM tracking, email sequences, landing pages
|
||||
- **Analytics** - ROI analysis, funnel analysis, executive dashboards
|
||||
- **Content** - Ad copy, social media, SEO optimization
|
||||
- **Lead Generation** - Cold outreach, personalization at scale
|
||||
|
||||
## Advanced Options
|
||||
|
||||
```bash
|
||||
# Install globally
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow --global
|
||||
|
||||
# Install specific skill
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow --skill utm-builder
|
||||
|
||||
# List all skills
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow --list
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
- [View on GitHub](https://github.com/nicepkg/ai-workflow/tree/main/workflows/marketing-pro-workflow)
|
||||
- [Contributing](/docs/contributing)
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
title: Product Manager Workflow
|
||||
description: Pre-configured skills for product managers and product owners
|
||||
---
|
||||
|
||||
# Product Manager Workflow
|
||||
|
||||
A professional collection of 23 skills designed for product managers, product owners, and product leaders.
|
||||
|
||||
## Target Users
|
||||
|
||||
- Product Managers
|
||||
- Product Owners
|
||||
- Head of Product / VP
|
||||
- Technical Program Managers
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow
|
||||
```
|
||||
|
||||
## Included Skills
|
||||
|
||||
`work-intake` `user-research` `discovery-interviews-surveys` `customer-feedback-analyzer` `user-persona-creation` `competitive-analysis` `prd-generator` `writing-product-specs` `requirements` `writing-user-stories` `prioritization-effort-impact` `roadmap` `roadmap-backcast` `strategy` `stakeholders-org-design` `feature-planning` `agile` `agile-sprint-planning` `launch` `technical-launch-planner` `analytics` `forecast-premortem` `postmortem`
|
||||
|
||||
## Key Capabilities
|
||||
|
||||
### Intake & Triage
|
||||
- **work-intake** - Convert any request into trackable work items
|
||||
|
||||
### Discovery & Research
|
||||
- **user-research** - User interviews, surveys, problem validation
|
||||
- **customer-feedback-analyzer** - Multi-channel feedback analysis
|
||||
- **user-persona-creation** - Create detailed user personas
|
||||
- **competitive-analysis** - Market and competitor analysis
|
||||
|
||||
### Definition & Specification
|
||||
- **prd-generator** - Generate structured PRDs
|
||||
- **writing-product-specs** - Feature specs with context and requirements
|
||||
- **writing-user-stories** - Standard format user stories
|
||||
|
||||
### Prioritization & Planning
|
||||
- **prioritization-effort-impact** - Effort-Impact 2x2 matrix
|
||||
- **roadmap** - Timeline and resource allocation
|
||||
- **strategy** - Product strategy and OKRs
|
||||
|
||||
### Delivery & Execution
|
||||
- **feature-planning** - Implementation plans
|
||||
- **agile** - Sprint planning and velocity tracking
|
||||
|
||||
### Launch & Review
|
||||
- **launch** - Product launch coordination
|
||||
- **analytics** - Product analytics and KPIs
|
||||
- **postmortem** - Post-launch review and lessons learned
|
||||
|
||||
## Advanced Options
|
||||
|
||||
```bash
|
||||
# Install globally
|
||||
npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow --global
|
||||
|
||||
# Install specific skill
|
||||
npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow --skill prd-generator
|
||||
|
||||
# List all skills
|
||||
npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow --list
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
- [View on GitHub](https://github.com/nicepkg/ai-workflow/tree/main/workflows/product-manager-workflow)
|
||||
- [Contributing](/docs/contributing)
|
||||
@@ -0,0 +1,63 @@
|
||||
---
|
||||
title: Stock Trader Workflow
|
||||
description: Pre-configured skills for financial analysts and traders
|
||||
---
|
||||
|
||||
# Stock Trader Workflow
|
||||
|
||||
A professional collection of 29 skills for financial analysts, traders, and investment researchers covering US, CN, HK, and TW markets.
|
||||
|
||||
## Target Users
|
||||
|
||||
- Stock traders
|
||||
- Financial analysts
|
||||
- Investment researchers
|
||||
- Portfolio managers
|
||||
- Quantitative analysts
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow
|
||||
```
|
||||
|
||||
## Included Skills
|
||||
|
||||
`akshare` `股票分析` `stock-screener` `shioaji` `us-stock-analysis` `a-share-analysis` `hk-stock-analysis` `technical-analyst` `china-macro-analyst` `cross-border-flow-tracker` `a-share-screener` `portfolio-manager` `earnings-calendar` `market-news-analyst` `canslim-screener` `value-dividend-screener` `sector-analyst` `options-strategy-advisor` `backtest-expert` `scenario-analyzer` `institutional-flow-tracker` `market-environment-analysis` `breadth-chart-analyst` `pair-trade-screener` `dividend-growth-pullback-screener` `economic-calendar-fetcher` `weekly-trade-strategy` `us-market-bubble-detector` `stanley-druckenmiller-investment`
|
||||
|
||||
## Key Capabilities
|
||||
|
||||
- **Market Analysis** - US, A-share, HK stock analysis
|
||||
- **Technical Analysis** - Chart patterns, indicators, breadth analysis
|
||||
- **Fundamental Analysis** - CANSLIM, value investing, dividend screening
|
||||
- **Portfolio Management** - Allocation, backtesting, scenario analysis
|
||||
- **Market Intelligence** - News analysis, institutional flows, macro analysis
|
||||
|
||||
## Supported Markets
|
||||
|
||||
- **US Markets** - NYSE, NASDAQ
|
||||
- **China A-Shares** - Shanghai, Shenzhen
|
||||
- **Hong Kong** - HKEX
|
||||
- **Taiwan** - TWSE
|
||||
|
||||
## Disclaimer
|
||||
|
||||
This workflow provides tools for research and analysis only. It does not constitute financial advice. Always consult with qualified financial professionals before making investment decisions.
|
||||
|
||||
## Advanced Options
|
||||
|
||||
```bash
|
||||
# Install globally
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow --global
|
||||
|
||||
# Install specific skill
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow --skill a-share-analysis
|
||||
|
||||
# List all skills
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow --list
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
- [View on GitHub](https://github.com/nicepkg/ai-workflow/tree/main/workflows/stock-trader-workflow)
|
||||
- [Contributing](/docs/contributing)
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
title: Talk to Slidev Workflow
|
||||
description: Pre-configured skills for keynote speakers and presentation creators
|
||||
---
|
||||
|
||||
# Talk to Slidev Workflow
|
||||
|
||||
A specialized collection of 18 skills for keynote speakers, tech conference presenters, and educators to create beautiful Slidev presentations.
|
||||
|
||||
## Target Users
|
||||
|
||||
- Keynote Speakers
|
||||
- Tech Conference Presenters
|
||||
- Startup Founders (Pitch Decks)
|
||||
- Educators & Trainers
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow
|
||||
```
|
||||
|
||||
## Included Skills
|
||||
|
||||
`storyline-builder` `presentation-builder` `ppt-creator` `presentation-generator` `theme-factory` `presentation-design-enhancer` `color-palette-extractor` `font-pairing-suggester` `canvas-design` `pexels-media` `nano-banana-pro` `youtube-transcript` `transcribe-and-analyze` `mermaid-diagrams` `mermaid-tools` `infographic-creation` `pptx` `social-repurposer`
|
||||
|
||||
## Key Capabilities
|
||||
|
||||
### Idea to Narrative Structure
|
||||
- **storyline-builder** - McKinsey MECE narrative framework
|
||||
- **presentation-builder** - General presentation structure
|
||||
|
||||
### Script & Speaker Notes
|
||||
- **ppt-creator** - Complete speech script and speaker notes
|
||||
- **presentation-generator** - HTML deck generation
|
||||
|
||||
### Visual Theme & Design
|
||||
- **theme-factory** - One-click theme selection
|
||||
- **presentation-design-enhancer** - Transform bullets into visuals
|
||||
- **color-palette-extractor** - Extract color schemes from images
|
||||
- **font-pairing-suggester** - Professional font combinations
|
||||
|
||||
### Media & Assets
|
||||
- **pexels-media** - Find royalty-free images and videos
|
||||
- **nano-banana-pro** - AI-generated illustrations
|
||||
- **youtube-transcript** - Extract content from YouTube
|
||||
|
||||
### Diagrams & Infographics
|
||||
- **mermaid-diagrams** - Flowcharts, architecture diagrams
|
||||
- **mermaid-tools** - Advanced Mermaid editing
|
||||
- **infographic-creation** - Transform text into infographics
|
||||
|
||||
### Export & Repurpose
|
||||
- **pptx** - Export to PowerPoint format
|
||||
- **social-repurposer** - Repurpose slides for social media
|
||||
|
||||
## Advanced Options
|
||||
|
||||
```bash
|
||||
# Install globally
|
||||
npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow --global
|
||||
|
||||
# Install specific skill
|
||||
npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow --skill ppt-creator
|
||||
|
||||
# List all skills
|
||||
npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow --list
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
- [View on GitHub](https://github.com/nicepkg/ai-workflow/tree/main/workflows/talk-to-slidev-workflow)
|
||||
- [Contributing](/docs/contributing)
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: Video Creator Workflow
|
||||
description: Pre-configured skills for video producers and content creators
|
||||
---
|
||||
|
||||
# Video Creator Workflow
|
||||
|
||||
A specialized collection of 29 skills for video producers, YouTube creators, and multimedia content teams.
|
||||
|
||||
## Target Users
|
||||
|
||||
- YouTube creators
|
||||
- TikTok content creators
|
||||
- Video producers
|
||||
- Podcast hosts
|
||||
- Streaming content creators
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow
|
||||
```
|
||||
|
||||
## Included Skills
|
||||
|
||||
`serpapi` `content-trend-researcher` `content-research` `capture-triage` `youtube-transcript` `youtube-to-markdown` `transcribe-and-analyze` `video-downloader` `tapestry` `video-script-writer` `video-script-collaborial` `video-hook-generator` `video-title-optimizer` `thumbnail-concept-generator` `canvas-design` `pexels-media` `media-processing` `video-to-gif` `youtube-seo-optimizer` `short-form-converter` `social-repurposer` `srt-translator` `instagram` `video-analytics-interpreter` `posthog-analytics` `webfluence` `sponsor-pitch-generator` `video-comparer` `n8n-skills`
|
||||
|
||||
## Key Capabilities
|
||||
|
||||
- **Research** - Trend analysis, content research, competitor analysis
|
||||
- **Production** - Script writing, thumbnail concepts, video hooks
|
||||
- **Optimization** - YouTube SEO, title optimization, analytics
|
||||
- **Repurposing** - Short-form conversion, social media adaptation
|
||||
- **Monetization** - Sponsor pitch generation, analytics interpretation
|
||||
|
||||
## Advanced Options
|
||||
|
||||
```bash
|
||||
# Install globally
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow --global
|
||||
|
||||
# Install specific skill
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow --skill video-script-writer
|
||||
|
||||
# List all skills
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow --list
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
- [View on GitHub](https://github.com/nicepkg/ai-workflow/tree/main/workflows/video-creator-workflow)
|
||||
- [Contributing](/docs/contributing)
|
||||
@@ -0,0 +1,14 @@
|
||||
export default {
|
||||
index: {
|
||||
title: "首页",
|
||||
type: "page",
|
||||
},
|
||||
docs: {
|
||||
title: "文档",
|
||||
type: "page",
|
||||
},
|
||||
workflows: {
|
||||
title: "工作流",
|
||||
type: "page",
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,8 @@
|
||||
export default {
|
||||
"getting-started": "快速开始",
|
||||
installation: "安装指南",
|
||||
"supported-tools": "支持的 AI 工具",
|
||||
"creating-skills": "创建技能",
|
||||
"creating-workflows": "创建工作流",
|
||||
contributing: "贡献指南",
|
||||
};
|
||||
@@ -0,0 +1,123 @@
|
||||
---
|
||||
title: 贡献指南
|
||||
description: 如何为 AI Workflow 做贡献
|
||||
---
|
||||
|
||||
# 贡献指南
|
||||
|
||||
我们欢迎对 AI Workflow 的贡献!本指南将说明如何贡献。
|
||||
|
||||
## 贡献方式
|
||||
|
||||
- **新技能** - 为社区创建有用的技能
|
||||
- **新工作流** - 为特定用例策划技能集合
|
||||
- **Bug 修复** - 修复现有技能或文档中的问题
|
||||
- **文档** - 改进指南和示例
|
||||
- **翻译** - 帮助翻译文档
|
||||
|
||||
## 开始
|
||||
|
||||
1. 在 GitHub 上 Fork 仓库
|
||||
2. 克隆你的 Fork:
|
||||
```bash
|
||||
git clone https://github.com/your-username/ai-workflow.git
|
||||
cd ai-workflow
|
||||
```
|
||||
|
||||
3. 为你的贡献创建分支:
|
||||
```bash
|
||||
git checkout -b feature/my-contribution
|
||||
```
|
||||
|
||||
## 贡献技能
|
||||
|
||||
### 1. 创建你的技能
|
||||
|
||||
```bash
|
||||
mkdir -p workflows/your-workflow/.claude/skills/your-skill
|
||||
```
|
||||
|
||||
### 2. 编写 SKILL.md
|
||||
|
||||
按照 [创建技能](/zh/docs/creating-skills) 指南编写你的技能定义。
|
||||
|
||||
### 3. 测试你的技能
|
||||
|
||||
用多个 AI 助手测试技能以确保兼容性。
|
||||
|
||||
### 4. 提交 Pull Request
|
||||
|
||||
推送你的更改并创建 Pull Request:
|
||||
|
||||
```bash
|
||||
git add .
|
||||
git commit -m "feat: add your-skill to your-workflow"
|
||||
git push origin feature/my-contribution
|
||||
```
|
||||
|
||||
## 贡献工作流
|
||||
|
||||
### 1. 创建工作流结构
|
||||
|
||||
使用工作流创建脚本:
|
||||
|
||||
```bash
|
||||
python .claude/skills/workflow-creator/scripts/create_workflow.py my-workflow --path ./workflows
|
||||
```
|
||||
|
||||
### 2. 添加技能
|
||||
|
||||
为你的工作流添加至少 10 个有用的技能。
|
||||
|
||||
### 3. 编写文档
|
||||
|
||||
- `README.md` - 面向用户的文档
|
||||
- `AGENTS.md` - AI 指令
|
||||
|
||||
### 4. 验证软链接
|
||||
|
||||
确保所有 13 个 AI 工具软链接正确创建。
|
||||
|
||||
## Pull Request 指南
|
||||
|
||||
### 检查清单
|
||||
|
||||
对于新工作流:
|
||||
- [ ] 包含 README.md
|
||||
- [ ] 包含 README_cn.md(中文文档)
|
||||
- [ ] 包含 AGENTS.md
|
||||
- [ ] 包含至少 10 个技能
|
||||
- [ ] 创建所有软链接
|
||||
|
||||
对于新技能:
|
||||
- [ ] SKILL.md 有有效的 frontmatter
|
||||
- [ ] 清晰、可操作的指令
|
||||
- [ ] 包含示例
|
||||
- [ ] 至少用一个 AI 工具测试过
|
||||
|
||||
### 提交信息
|
||||
|
||||
使用约定式提交:
|
||||
|
||||
```
|
||||
feat: add new skill for X
|
||||
fix: correct typo in skill instructions
|
||||
docs: improve getting started guide
|
||||
```
|
||||
|
||||
### 代码审查
|
||||
|
||||
- 所有 PR 在合并前需要审查
|
||||
- 及时处理反馈
|
||||
- 保持讨论建设性
|
||||
|
||||
## 行为准则
|
||||
|
||||
贡献前请阅读我们的 [行为准则](https://github.com/nicepkg/ai-workflow/blob/main/CODE_OF_CONDUCT.md)。
|
||||
|
||||
## 有问题?
|
||||
|
||||
- 在 GitHub 上创建 issue
|
||||
- 加入仓库的讨论
|
||||
|
||||
感谢你的贡献!
|
||||
@@ -0,0 +1,133 @@
|
||||
---
|
||||
title: 创建技能
|
||||
description: 如何创建你自己的 AI 技能
|
||||
---
|
||||
|
||||
# 创建技能
|
||||
|
||||
技能是可重用的指令,用于扩展你的 AI 助手的能力。本指南将向你展示如何创建自己的技能。
|
||||
|
||||
## 技能结构
|
||||
|
||||
每个技能是一个至少包含 `SKILL.md` 文件的文件夹:
|
||||
|
||||
```
|
||||
skill-name/
|
||||
├── SKILL.md # 必需:技能定义
|
||||
├── scripts/ # 可选:辅助脚本
|
||||
│ └── helper.py
|
||||
├── templates/ # 可选:文件模板
|
||||
│ └── template.md
|
||||
└── references/ # 可选:参考资料
|
||||
└── guide.md
|
||||
```
|
||||
|
||||
## SKILL.md 格式
|
||||
|
||||
`SKILL.md` 文件定义你的技能:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: my-skill
|
||||
description: 简要描述这个技能的功能和用途
|
||||
---
|
||||
|
||||
# 我的技能
|
||||
|
||||
## 概述
|
||||
解释这个技能的功能以及何时使用它。
|
||||
|
||||
## 指令
|
||||
AI 需要遵循的分步指令。
|
||||
|
||||
### 步骤 1:分析
|
||||
描述第一步...
|
||||
|
||||
### 步骤 2:执行
|
||||
描述第二步...
|
||||
|
||||
## 示例
|
||||
|
||||
### 示例 1
|
||||
展示一个输入示例和预期输出。
|
||||
|
||||
## 注意事项
|
||||
任何额外的上下文或警告。
|
||||
```
|
||||
|
||||
## 最佳实践
|
||||
|
||||
### 1. 清晰的指令
|
||||
编写的指令应该:
|
||||
- 具体且可操作
|
||||
- 分解为编号步骤
|
||||
- 在有帮助的地方包含示例
|
||||
|
||||
### 2. 适当的范围
|
||||
每个技能应该:
|
||||
- 专注做好一件事
|
||||
- 可在项目间重用
|
||||
- 不与其他技能重叠
|
||||
|
||||
### 3. 良好的命名
|
||||
- 使用小写字母和连字符:`my-skill-name`
|
||||
- 描述性但简洁
|
||||
- 避免通用名称如 `helper` 或 `utils`
|
||||
|
||||
## 添加到工作流
|
||||
|
||||
1. 在 `.claude/skills/` 中创建你的技能文件夹:
|
||||
|
||||
```bash
|
||||
mkdir -p .claude/skills/my-skill
|
||||
```
|
||||
|
||||
2. 创建 `SKILL.md` 文件:
|
||||
|
||||
```bash
|
||||
touch .claude/skills/my-skill/SKILL.md
|
||||
```
|
||||
|
||||
3. 编辑 `SKILL.md` 写入你的技能定义
|
||||
|
||||
4. 用你的 AI 助手测试技能
|
||||
|
||||
## 示例技能
|
||||
|
||||
这是一个完整的文档生成技能示例:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: write-docs
|
||||
description: 为代码生成文档
|
||||
---
|
||||
|
||||
# 文档生成器
|
||||
|
||||
## 概述
|
||||
为代码文件、函数和模块生成全面的文档。
|
||||
|
||||
## 指令
|
||||
|
||||
### 步骤 1:分析代码
|
||||
- 识别代码的目的
|
||||
- 记录所有公共函数和类
|
||||
- 理解输入/输出类型
|
||||
|
||||
### 步骤 2:生成文档
|
||||
- 编写模块级文档字符串
|
||||
- 为每个公共函数编写文档
|
||||
- 包含参数类型和返回值
|
||||
- 添加使用示例
|
||||
|
||||
### 步骤 3:审查
|
||||
- 确保文档准确
|
||||
- 检查完整性
|
||||
- 验证示例可用
|
||||
|
||||
## 输出格式
|
||||
使用项目现有的文档风格。默认:
|
||||
- JavaScript/TypeScript 使用 JSDoc
|
||||
- Python 使用 Docstrings
|
||||
- C# 使用 XML 注释
|
||||
```
|
||||
@@ -0,0 +1,151 @@
|
||||
---
|
||||
title: 创建工作流
|
||||
description: 如何创建包含精选技能的自定义工作流
|
||||
---
|
||||
|
||||
# 创建工作流
|
||||
|
||||
工作流是为特定用例设计的精选技能集合。本指南将向你展示如何创建自己的工作流。
|
||||
|
||||
## 方法一:AI 辅助创建(推荐)
|
||||
|
||||
最简单的创建工作流方式是让你的 AI 助手来完成。
|
||||
|
||||
### 步骤 1:克隆仓库
|
||||
|
||||
```bash
|
||||
git clone https://github.com/nicepkg/ai-workflow.git
|
||||
cd ai-workflow
|
||||
```
|
||||
|
||||
### 步骤 2:使用 AI 编程助手打开
|
||||
|
||||
使用任何支持技能的 AI 工具打开项目:
|
||||
- **Claude Code**:在终端中运行 `claude`
|
||||
- **Cursor**:在 Cursor 中打开文件夹
|
||||
- **Codex**:在终端中运行 `codex`
|
||||
- **OpenCode**:在终端中运行 `opencode`
|
||||
|
||||
### 步骤 3:让 AI 创建你的工作流
|
||||
|
||||
只需描述你的需求:
|
||||
|
||||
```
|
||||
"创建一个用于学术论文写作的研究员工作流"
|
||||
"创建一个用于 kubernetes 管理的 devops 工作流"
|
||||
"创建一个用于 ML 项目的数据科学家工作流"
|
||||
```
|
||||
|
||||
AI 会自动:
|
||||
1. 创建工作流目录结构
|
||||
2. 从技能源找到并下载相关技能
|
||||
3. 根据需要创建自定义技能
|
||||
4. 生成文档(README.md、AGENTS.md)
|
||||
5. 为所有 AI 工具设置软链接
|
||||
|
||||
## 方法二:手动创建
|
||||
|
||||
完全控制工作流结构。
|
||||
|
||||
### 工作流结构
|
||||
|
||||
```
|
||||
workflows/my-workflow/
|
||||
├── README.md # 用户文档
|
||||
├── AGENTS.md # AI 指令
|
||||
├── .claude/
|
||||
│ ├── settings.json
|
||||
│ └── skills/ # 主要技能存储
|
||||
│ ├── skill-1/
|
||||
│ │ └── SKILL.md
|
||||
│ └── skill-2/
|
||||
│ └── SKILL.md
|
||||
├── .cursor/
|
||||
│ └── skills -> ../.claude/skills
|
||||
├── .codex/
|
||||
│ └── skills -> ../.claude/skills
|
||||
└── ...(其他 AI 工具软链接)
|
||||
```
|
||||
|
||||
### 创建目录结构
|
||||
|
||||
```bash
|
||||
# 创建工作流目录
|
||||
mkdir -p workflows/my-workflow/.claude/skills
|
||||
|
||||
# 创建设置文件
|
||||
echo '{"permissions": {}}' > workflows/my-workflow/.claude/settings.json
|
||||
|
||||
# 创建文档文件
|
||||
touch workflows/my-workflow/README.md
|
||||
touch workflows/my-workflow/AGENTS.md
|
||||
```
|
||||
|
||||
### 创建软链接
|
||||
|
||||
```bash
|
||||
cd workflows/my-workflow
|
||||
|
||||
# 为每个 AI 工具创建目录
|
||||
mkdir -p .cursor .codex .opencode .agents .kilocode .roo .goose .gemini .agent .github .factory .windsurf
|
||||
|
||||
# 创建软链接
|
||||
ln -s ../.claude/skills .cursor/skills
|
||||
ln -s ../.claude/skills .codex/skills
|
||||
ln -s ../.claude/skills .opencode/skill
|
||||
ln -s ../.claude/skills .agents/skills
|
||||
ln -s ../.claude/skills .kilocode/skills
|
||||
ln -s ../.claude/skills .roo/skills
|
||||
ln -s ../.claude/skills .goose/skills
|
||||
ln -s ../.claude/skills .gemini/skills
|
||||
ln -s ../.claude/skills .agent/skills
|
||||
ln -s ../.claude/skills .github/skills
|
||||
ln -s ../.claude/skills .factory/skills
|
||||
ln -s ../.claude/skills .windsurf/skills
|
||||
ln -s .claude/skills skills
|
||||
```
|
||||
|
||||
## 添加技能
|
||||
|
||||
### 选项 1:从技能源下载
|
||||
|
||||
技能可以从以下来源获取:
|
||||
- [Anthropic 官方技能](https://github.com/anthropics/skills)
|
||||
- [vercel-labs/agent-skills](https://github.com/vercel-labs/agent-skills)
|
||||
- [ComposioHQ/awesome-claude-skills](https://github.com/ComposioHQ/awesome-claude-skills)
|
||||
- [skillhub.club](https://www.skillhub.club) - 1000+ 技能集合
|
||||
|
||||
### 选项 2:创建自定义技能
|
||||
|
||||
在 `.claude/skills/` 中创建新技能:
|
||||
|
||||
```bash
|
||||
mkdir -p .claude/skills/my-skill
|
||||
```
|
||||
|
||||
创建 `SKILL.md`:
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: my-skill
|
||||
description: 这个技能的功能以及 AI 应该何时使用它
|
||||
---
|
||||
|
||||
# 我的技能
|
||||
|
||||
AI 需要遵循的指令...
|
||||
```
|
||||
|
||||
详细指导请参阅 [创建技能](/zh/docs/creating-skills)。
|
||||
|
||||
## 发布你的工作流
|
||||
|
||||
1. Fork [ai-workflow 仓库](https://github.com/nicepkg/ai-workflow)
|
||||
2. 将你的工作流添加到 `workflows/` 目录
|
||||
3. 更新主 README.md 添加你的工作流
|
||||
4. 提交 Pull Request
|
||||
|
||||
你的工作流将可以通过以下方式安装:
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/your-workflow
|
||||
```
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: 快速开始
|
||||
description: 学习如何在你喜欢的 AI 编程助手中使用 AI Workflow
|
||||
---
|
||||
|
||||
# 快速开始
|
||||
|
||||
AI Workflow 为 AI 编程助手提供预配置的技能集。本指南将帮助你快速上手。
|
||||
|
||||
## 前置条件
|
||||
|
||||
- 已安装 Node.js 18+
|
||||
- 一个 AI 编程助手(Claude Code、Cursor、Copilot 等)
|
||||
|
||||
## 快速开始
|
||||
|
||||
### 安装完整工作流(推荐)
|
||||
|
||||
```bash
|
||||
# 选择你的工作流,运行一条命令:
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow
|
||||
|
||||
# 完成!技能已在你的 AI 助手中激活。
|
||||
```
|
||||
|
||||
### 可用工作流
|
||||
|
||||
| 工作流 | 适用人群 | 技能数 | 安装命令 |
|
||||
|:-------|:---------|:------:|:---------|
|
||||
| 内容创作者 | 博主、写手、SEO 专家 | 32 | `npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow` |
|
||||
| 营销专家 | 数字营销人、增长黑客、PMM | 38 | `npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow` |
|
||||
| 视频创作者 | YouTuber、TikToker、视频制作人 | 29 | `npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow` |
|
||||
| 股票交易员 | 交易员、投资者(美/中/港/台) | 29 | `npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow` |
|
||||
| 产品经理 | PM、产品负责人 | 23 | `npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow` |
|
||||
| Talk to Slidev | 演讲者、讲师、教育工作者 | 18 | `npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow` |
|
||||
|
||||
### 安装单个技能
|
||||
|
||||
```bash
|
||||
# 只安装你需要的
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow --skill a-share-analysis
|
||||
|
||||
# 先列出可用技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow --list
|
||||
```
|
||||
|
||||
### 高级选项
|
||||
|
||||
```bash
|
||||
# 全局安装(在所有项目中可用)
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow --global
|
||||
|
||||
# 只安装到指定的 AI 工具
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow -a claude-code -a cursor
|
||||
|
||||
# 非交互模式(用于 CI/CD)
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow -y
|
||||
```
|
||||
|
||||
## 验证安装
|
||||
|
||||
安装后,技能应该会自动在你的 AI 助手中可用。尝试在对话中提及技能名称或用途来使用它。
|
||||
|
||||
## 下一步
|
||||
|
||||
- [安装选项](/zh/docs/installation) - 更多安装方式
|
||||
- [支持的工具](/zh/docs/supported-tools) - 完整的支持 AI 工具列表
|
||||
- [创建技能](/zh/docs/creating-skills) - 创建你自己的技能
|
||||
@@ -0,0 +1,148 @@
|
||||
---
|
||||
title: 安装指南
|
||||
description: 安装和使用 AI Workflow 的不同方式
|
||||
---
|
||||
|
||||
# 安装指南
|
||||
|
||||
有多种方式在你的项目中使用 AI Workflow。
|
||||
|
||||
## 方法一:npx add-skill(推荐)
|
||||
|
||||
最简单的安装方式,无需任何设置。
|
||||
|
||||
### 安装完整工作流
|
||||
|
||||
```bash
|
||||
# 内容创作者、博主、写手
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow
|
||||
|
||||
# 数字营销人、增长黑客
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow
|
||||
|
||||
# YouTuber、视频制作人
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow
|
||||
|
||||
# 股票交易员、投资者
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow
|
||||
|
||||
# 产品经理
|
||||
npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow
|
||||
|
||||
# 演示文稿创作者
|
||||
npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow
|
||||
```
|
||||
|
||||
### 安装单个技能
|
||||
|
||||
```bash
|
||||
# 列出工作流中的可用技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow --list
|
||||
|
||||
# 安装特定技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow --skill a-share-analysis
|
||||
```
|
||||
|
||||
### 安装选项
|
||||
|
||||
```bash
|
||||
# 全局安装(在所有项目中可用)
|
||||
npx add-skill <workflow> --global
|
||||
|
||||
# 只安装到指定的 AI 工具
|
||||
npx add-skill <workflow> -a claude-code -a cursor
|
||||
|
||||
# 非交互模式(用于 CI/CD)
|
||||
npx add-skill <workflow> -y
|
||||
|
||||
# 指定安装目录
|
||||
npx add-skill <workflow> --path ./my-project
|
||||
```
|
||||
|
||||
## 方法二:手动安装
|
||||
|
||||
适合需要更多控制的高级用户。
|
||||
|
||||
### 克隆并复制
|
||||
|
||||
```bash
|
||||
# 克隆仓库
|
||||
git clone https://github.com/nicepkg/ai-workflow.git
|
||||
|
||||
# 将工作流的技能复制到你的项目
|
||||
cp -r ai-workflow/workflows/content-creator-workflow/.claude/skills your-project/.claude/
|
||||
```
|
||||
|
||||
### 为其他 AI 工具创建软链接
|
||||
|
||||
```bash
|
||||
cd your-project
|
||||
|
||||
# 创建目录
|
||||
mkdir -p .cursor .codex .opencode
|
||||
|
||||
# 创建软链接
|
||||
ln -s ../.claude/skills .cursor/skills
|
||||
ln -s ../.claude/skills .codex/skills
|
||||
ln -s ../.claude/skills .opencode/skill
|
||||
```
|
||||
|
||||
## 目录结构
|
||||
|
||||
安装后,你的项目将包含:
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── .claude/
|
||||
│ └── skills/ # 主要技能存储
|
||||
│ ├── skill-1/
|
||||
│ │ └── SKILL.md
|
||||
│ └── skill-2/
|
||||
│ └── SKILL.md
|
||||
├── .cursor/
|
||||
│ └── skills -> ../.claude/skills
|
||||
├── .codex/
|
||||
│ └── skills -> ../.claude/skills
|
||||
└── ...(其他 AI 工具软链接)
|
||||
```
|
||||
|
||||
## 全局安装 vs 项目安装
|
||||
|
||||
| 类型 | 位置 | 使用场景 |
|
||||
|:-----|:-----|:---------|
|
||||
| 项目级 | `.claude/skills/` | 特定项目专用的技能 |
|
||||
| 全局 | `~/.claude/skills/` | 所有项目都可用的技能 |
|
||||
|
||||
```bash
|
||||
# 项目安装(默认)
|
||||
npx add-skill <workflow>
|
||||
|
||||
# 全局安装
|
||||
npx add-skill <workflow> --global
|
||||
```
|
||||
|
||||
## 更新技能
|
||||
|
||||
```bash
|
||||
# 重新安装以获取最新版本
|
||||
npx add-skill <workflow>
|
||||
|
||||
# 或者手动拉取最新并复制
|
||||
cd ai-workflow
|
||||
git pull origin main
|
||||
```
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 技能未加载?
|
||||
|
||||
1. 检查技能是否在你的 AI 工具的正确目录中
|
||||
2. 重启你的 AI 助手
|
||||
3. 验证 `SKILL.md` 文件是否存在
|
||||
|
||||
### 权限错误?
|
||||
|
||||
```bash
|
||||
# 在 Unix/Mac 上修复权限
|
||||
chmod -R 755 .claude/skills
|
||||
```
|
||||
@@ -0,0 +1,89 @@
|
||||
---
|
||||
title: 支持的 AI 工具
|
||||
description: AI Workflow 支持的 AI 编程助手完整列表
|
||||
---
|
||||
|
||||
# 支持的 AI 工具
|
||||
|
||||
AI Workflow 开箱即支持 **14+ AI 编程助手**。所有工具通过软链接架构共享相同的技能。
|
||||
|
||||
## 架构
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── .claude/
|
||||
│ └── skills/ ← 主存储(真实文件)
|
||||
├── .cursor/
|
||||
│ └── skills ← 软链接 → ../.claude/skills
|
||||
├── .codex/
|
||||
│ └── skills ← 软链接 → ../.claude/skills
|
||||
├── .opencode/
|
||||
│ └── skill ← 软链接 → ../.claude/skills
|
||||
└── ...(其他软链接)
|
||||
```
|
||||
|
||||
## 支持的工具
|
||||
|
||||
| AI 工具 | 项目路径 | 全局路径 | 备注 |
|
||||
|:--------|:---------|:---------|:-----|
|
||||
| **Claude Code** | `.claude/skills/` | `~/.claude/skills/` | 主存储 |
|
||||
| **Cursor** | `.cursor/skills/` | `~/.cursor/skills/` | 软链接 |
|
||||
| **GitHub Copilot** | `.github/skills/` | `~/.copilot/skills/` | 软链接 |
|
||||
| **Codex** | `.codex/skills/` | `~/.codex/skills/` | 软链接 |
|
||||
| **OpenCode** | `.opencode/skill/` | `~/.config/opencode/skill/` | 软链接(单数) |
|
||||
| **Amp** | `.agents/skills/` | `~/.config/agents/skills/` | 软链接 |
|
||||
| **Roo Code** | `.roo/skills/` | `~/.roo/skills/` | 软链接 |
|
||||
| **Kilo Code** | `.kilocode/skills/` | `~/.kilocode/skills/` | 软链接 |
|
||||
| **Goose** | `.goose/skills/` | `~/.config/goose/skills/` | 软链接 |
|
||||
| **Gemini CLI** | `.gemini/skills/` | `~/.gemini/skills/` | 软链接 |
|
||||
| **Antigravity** | `.agent/skills/` | `~/.gemini/antigravity/skills/` | 软链接 |
|
||||
| **Clawdbot** | `skills/` | `~/.clawdbot/skills/` | 根级软链接 |
|
||||
| **Droid** | `.factory/skills/` | `~/.factory/skills/` | 软链接 |
|
||||
| **Windsurf** | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` | 软链接 |
|
||||
|
||||
## 创建软链接
|
||||
|
||||
使用提供的脚本自动创建所有软链接:
|
||||
|
||||
```bash
|
||||
python scripts/create_workflow.py my-workflow --path ./workflows
|
||||
```
|
||||
|
||||
或手动创建:
|
||||
|
||||
```bash
|
||||
# 创建目录
|
||||
mkdir -p .cursor .codex .opencode .agents .kilocode .roo .goose .gemini .agent .github .factory .windsurf
|
||||
|
||||
# 创建软链接
|
||||
ln -s ../.claude/skills .cursor/skills
|
||||
ln -s ../.claude/skills .codex/skills
|
||||
ln -s ../.claude/skills .opencode/skill
|
||||
ln -s ../.claude/skills .agents/skills
|
||||
ln -s ../.claude/skills .kilocode/skills
|
||||
ln -s ../.claude/skills .roo/skills
|
||||
ln -s ../.claude/skills .goose/skills
|
||||
ln -s ../.claude/skills .gemini/skills
|
||||
ln -s ../.claude/skills .agent/skills
|
||||
ln -s ../.claude/skills .github/skills
|
||||
ln -s ../.claude/skills .factory/skills
|
||||
ln -s ../.claude/skills .windsurf/skills
|
||||
ln -s .claude/skills skills
|
||||
```
|
||||
|
||||
## 特定工具说明
|
||||
|
||||
### OpenCode
|
||||
OpenCode 使用 `skill`(单数)而不是 `skills`:
|
||||
```bash
|
||||
ln -s ../.claude/skills .opencode/skill
|
||||
```
|
||||
|
||||
### Clawdbot
|
||||
Clawdbot 在根级别查找技能:
|
||||
```bash
|
||||
ln -s .claude/skills skills
|
||||
```
|
||||
|
||||
### GitHub Copilot
|
||||
GitHub Copilot 与 GitHub 工作流共享 `.github/` 目录。`skills/` 子目录不会与现有的 GitHub 配置冲突。
|
||||
@@ -0,0 +1,59 @@
|
||||
# AI Workflow
|
||||
|
||||
**为你的 AI 编程助手赋能预置技能集**
|
||||
|
||||
不再需要反复教导 AI 同样的事情。一条命令,170+ 专业技能,即刻提升生产力。
|
||||
|
||||
## 快速开始
|
||||
|
||||
```bash
|
||||
# 选择你的工作流,运行一条命令:
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow
|
||||
|
||||
# 完成!技能已在你的 AI 助手中激活。
|
||||
```
|
||||
|
||||
## 为什么选择 AI Workflow?
|
||||
|
||||
| 之前 | 之后 |
|
||||
|------|------|
|
||||
| "帮我写一篇博客..." 然后每次都要解释 SEO、格式、语气 | AI 已经知道你的内容策略、SEO 规则和品牌调性 |
|
||||
| 手动向 AI 解释股票分析概念 | AI 即刻进行专业的技术和基本面分析 |
|
||||
| 反复讲解营销框架和模板 | AI 生成符合品牌调性的文案,并带有正确的 UTM 追踪 |
|
||||
| 从笔记中复制粘贴提示词 | 技能根据你的项目自动激活 |
|
||||
|
||||
**AI Workflow** = 让你的 AI 助手成为特定领域专家的预配置技能集。
|
||||
|
||||
## 可用工作流
|
||||
|
||||
| 工作流 | 适用人群 | 技能数 | 安装命令 |
|
||||
|:-------|:---------|:------:|:---------|
|
||||
| [内容创作者](/zh/workflows/content-creator) | 博主、写手、SEO 专家 | 32 | `npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow` |
|
||||
| [营销专家](/zh/workflows/marketing-pro) | 数字营销人、增长黑客、PMM | 38 | `npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow` |
|
||||
| [视频创作者](/zh/workflows/video-creator) | YouTuber、TikToker、视频制作人 | 29 | `npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow` |
|
||||
| [股票交易员](/zh/workflows/stock-trader) | 交易员、投资者(美/中/港/台市场) | 29 | `npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow` |
|
||||
| [产品经理](/zh/workflows/product-manager) | PM、产品负责人、产品总监 | 23 | `npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow` |
|
||||
| [Talk to Slidev](/zh/workflows/talk-to-slidev) | 演讲者、技术讲师、教育工作者 | 18 | `npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow` |
|
||||
|
||||
## 支持的 AI 工具
|
||||
|
||||
开箱即支持 **14+ AI 编程助手**:
|
||||
|
||||
| AI 工具 | 项目路径 | 全局路径 |
|
||||
|:--------|:---------|:---------|
|
||||
| Claude Code | `.claude/skills/` | `~/.claude/skills/` |
|
||||
| Cursor | `.cursor/skills/` | `~/.cursor/skills/` |
|
||||
| GitHub Copilot | `.github/skills/` | `~/.copilot/skills/` |
|
||||
| Codex | `.codex/skills/` | `~/.codex/skills/` |
|
||||
| OpenCode | `.opencode/skill/` | `~/.config/opencode/skill/` |
|
||||
| Amp | `.agents/skills/` | `~/.config/agents/skills/` |
|
||||
| Roo Code | `.roo/skills/` | `~/.roo/skills/` |
|
||||
| Kilo Code | `.kilocode/skills/` | `~/.kilocode/skills/` |
|
||||
| Goose | `.goose/skills/` | `~/.config/goose/skills/` |
|
||||
| Gemini CLI | `.gemini/skills/` | `~/.gemini/skills/` |
|
||||
| Antigravity | `.agent/skills/` | `~/.gemini/antigravity/skills/` |
|
||||
| Clawdbot | `skills/` | `~/.clawdbot/skills/` |
|
||||
| Droid | `.factory/skills/` | `~/.factory/skills/` |
|
||||
| Windsurf | `.windsurf/skills/` | `~/.codeium/windsurf/skills/` |
|
||||
|
||||
[开始使用](/zh/docs/getting-started) | [在 GitHub 上查看](https://github.com/nicepkg/ai-workflow)
|
||||
@@ -0,0 +1,9 @@
|
||||
export default {
|
||||
index: "概览",
|
||||
"content-creator": "内容创作者",
|
||||
"marketing-pro": "营销专家",
|
||||
"video-creator": "视频创作者",
|
||||
"stock-trader": "股票交易员",
|
||||
"product-manager": "产品经理",
|
||||
"talk-to-slidev": "Talk to Slidev",
|
||||
};
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: 内容创作者工作流
|
||||
description: 为博主、作家和内容创作者预配置的技能集合
|
||||
---
|
||||
|
||||
# 内容创作者工作流
|
||||
|
||||
为内容创作者、博主和作家设计的 32 个精选技能集合。
|
||||
|
||||
## 目标用户
|
||||
|
||||
- 博主和文章作者
|
||||
- 技术文档作者
|
||||
- SEO 专家
|
||||
- 电子报发布者
|
||||
- 社交媒体内容创作者
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow
|
||||
```
|
||||
|
||||
## 包含的技能
|
||||
|
||||
`weak-signal-synthesizer` `content-trend-researcher` `competitive-ads-extractor` `twitter-reader` `article-extractor` `youtube-processor` `youtube-transcript` `content-research` `content-brief-generator` `content-brief` `skill-navigator` `blog-post-writer` `content-research-writer` `newsletter-coach` `fact-checker` `hook-stack-evaluator` `email-subject-line-optimizer` `ai-slop-detector` `content-repurposer` `social-repurposer` `social-media` `linkedin-announcement-generator` `podcast-content-suite` `pre-publish-post-assistant` `seo-wordpress-manager` `gsc-assistant` `astro-cta-injector` `nano-banana` `canvas-design` `docx` `pdf`
|
||||
|
||||
## 核心能力
|
||||
|
||||
- **内容研究** - 趋势分析、竞争研究、主题构思
|
||||
- **写作辅助** - 博客文章、电子报、社交媒体内容
|
||||
- **SEO 优化** - WordPress SEO、Google Search Console 集成
|
||||
- **内容复用** - 跨平台内容转换
|
||||
- **质量保证** - 事实核查、AI 内容检测
|
||||
|
||||
## 高级选项
|
||||
|
||||
```bash
|
||||
# 全局安装
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow --global
|
||||
|
||||
# 安装特定技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow --skill blog-post-writer
|
||||
|
||||
# 列出所有技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow --list
|
||||
```
|
||||
|
||||
## 链接
|
||||
|
||||
- [在 GitHub 上查看](https://github.com/nicepkg/ai-workflow/tree/main/workflows/content-creator-workflow)
|
||||
- [贡献指南](/zh/docs/contributing)
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: 工作流概览
|
||||
description: 浏览为不同用例预配置的 AI 工作流
|
||||
---
|
||||
|
||||
# 工作流
|
||||
|
||||
AI Workflow 为不同专业需求提供精选的技能集合。每个工作流都包含针对特定用例优化的精心挑选的技能。
|
||||
|
||||
## 可用工作流
|
||||
|
||||
| 工作流 | 适用人群 | 技能数 | 安装命令 |
|
||||
|:-------|:---------|:------:|:---------|
|
||||
| [内容创作者](/zh/workflows/content-creator) | 博主、作家、SEO 专家 | 32 | `npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow` |
|
||||
| [营销专家](/zh/workflows/marketing-pro) | 数字营销人、增长黑客、PMM | 38 | `npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow` |
|
||||
| [视频创作者](/zh/workflows/video-creator) | YouTuber、TikToker、视频制作人 | 29 | `npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow` |
|
||||
| [股票交易员](/zh/workflows/stock-trader) | 交易员、投资者(美股/A股/港股/台股) | 29 | `npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow` |
|
||||
| [产品经理](/zh/workflows/product-manager) | PM、产品负责人、产品总监 | 23 | `npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow` |
|
||||
| [Talk to Slidev](/zh/workflows/talk-to-slidev) | 演讲者、技术讲师、教育工作者 | 18 | `npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow` |
|
||||
|
||||
## 快速安装
|
||||
|
||||
```bash
|
||||
# 选择你的工作流,运行一条命令:
|
||||
npx add-skill nicepkg/ai-workflow/workflows/content-creator-workflow
|
||||
|
||||
# 完成!技能现在已在你的 AI 助手中激活。
|
||||
```
|
||||
|
||||
## 高级选项
|
||||
|
||||
```bash
|
||||
# 全局安装(在所有项目中可用)
|
||||
npx add-skill <workflow> --global
|
||||
|
||||
# 只安装特定技能
|
||||
npx add-skill <workflow> --skill skill-name
|
||||
|
||||
# 列出可用技能
|
||||
npx add-skill <workflow> --list
|
||||
```
|
||||
|
||||
## 创建自定义工作流
|
||||
|
||||
需要针对你特定用例的工作流?请参阅 [创建工作流](/zh/docs/creating-workflows) 来构建你自己的工作流。
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: 营销专家工作流
|
||||
description: 为营销专业人员和营销活动管理者预配置的技能集合
|
||||
---
|
||||
|
||||
# 营销专家工作流
|
||||
|
||||
为营销专业人员、营销活动管理者和增长团队提供的 38 个全面技能集合。
|
||||
|
||||
## 目标用户
|
||||
|
||||
- 数字营销人
|
||||
- 增长黑客
|
||||
- 产品营销经理(PMM)
|
||||
- 营销策略师
|
||||
- 品牌经理
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow
|
||||
```
|
||||
|
||||
## 包含的技能
|
||||
|
||||
`skill-navigator` `marketing` `buyer-persona-generator` `Go-to-Market-Planner` `prd-v09-gtm-strategy` `marketing-strategy-pmm` `pricing-strategist` `competitor-price-tracker` `competitive-ads-extractor` `copy` `ad-copy-generator` `content-optimizer` `content-brief` `landing-page` `landing-page-copywriter` `ui-ux-audit` `running-marketing-campaigns` `utm-builder` `qr-code-generator` `email-template-generator` `cold-email-sequence-generator` `cold-outreach-generator` `personalization-at-scale` `lead-research-assistant` `funnel-analysis` `analytics-interpretation` `technical-launch-planner` `launch-gtm-execution` `executive-dashboard-generator` `product-analytics` `roi-analyzer` `social-media-analyzer` `marketing-demand-acquisition` `seo-optimizer` `serp-analysis` `keyword-cluster-builder` `linkedin-post-optimizer` `social-repurposer`
|
||||
|
||||
## 核心能力
|
||||
|
||||
- **策略** - 市场进入规划、买家画像、定价策略
|
||||
- **营销活动管理** - UTM 追踪、邮件序列、落地页
|
||||
- **数据分析** - ROI 分析、漏斗分析、高管仪表盘
|
||||
- **内容** - 广告文案、社交媒体、SEO 优化
|
||||
- **线索生成** - 冷触达、规模化个性化
|
||||
|
||||
## 高级选项
|
||||
|
||||
```bash
|
||||
# 全局安装
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow --global
|
||||
|
||||
# 安装特定技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow --skill utm-builder
|
||||
|
||||
# 列出所有技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/marketing-pro-workflow --list
|
||||
```
|
||||
|
||||
## 链接
|
||||
|
||||
- [在 GitHub 上查看](https://github.com/nicepkg/ai-workflow/tree/main/workflows/marketing-pro-workflow)
|
||||
- [贡献指南](/zh/docs/contributing)
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
title: 产品经理工作流
|
||||
description: 为产品经理和产品负责人预配置的技能集合
|
||||
---
|
||||
|
||||
# 产品经理工作流
|
||||
|
||||
为产品经理、产品负责人和产品领导者设计的 23 个专业技能集合。
|
||||
|
||||
## 目标用户
|
||||
|
||||
- 产品经理
|
||||
- 产品负责人
|
||||
- 产品总监 / VP
|
||||
- 技术项目经理
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow
|
||||
```
|
||||
|
||||
## 包含的技能
|
||||
|
||||
`work-intake` `user-research` `discovery-interviews-surveys` `customer-feedback-analyzer` `user-persona-creation` `competitive-analysis` `prd-generator` `writing-product-specs` `requirements` `writing-user-stories` `prioritization-effort-impact` `roadmap` `roadmap-backcast` `strategy` `stakeholders-org-design` `feature-planning` `agile` `agile-sprint-planning` `launch` `technical-launch-planner` `analytics` `forecast-premortem` `postmortem`
|
||||
|
||||
## 核心能力
|
||||
|
||||
### 需求收集与分类
|
||||
- **work-intake** - 将任何请求转化为可追踪的工作项
|
||||
|
||||
### 发现与研究
|
||||
- **user-research** - 用户访谈、调研、问题验证
|
||||
- **customer-feedback-analyzer** - 多渠道反馈分析
|
||||
- **user-persona-creation** - 创建详细的用户画像
|
||||
- **competitive-analysis** - 市场和竞争对手分析
|
||||
|
||||
### 定义与规格
|
||||
- **prd-generator** - 生成结构化的 PRD
|
||||
- **writing-product-specs** - 带上下文和需求的功能规格
|
||||
- **writing-user-stories** - 标准格式的用户故事
|
||||
|
||||
### 优先级与规划
|
||||
- **prioritization-effort-impact** - 投入-影响 2x2 矩阵
|
||||
- **roadmap** - 时间线和资源分配
|
||||
- **strategy** - 产品策略和 OKR
|
||||
|
||||
### 交付与执行
|
||||
- **feature-planning** - 实施计划
|
||||
- **agile** - 冲刺计划和速度追踪
|
||||
|
||||
### 发布与复盘
|
||||
- **launch** - 产品发布协调
|
||||
- **analytics** - 产品分析和 KPI
|
||||
- **postmortem** - 发布后复盘和经验总结
|
||||
|
||||
## 高级选项
|
||||
|
||||
```bash
|
||||
# 全局安装
|
||||
npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow --global
|
||||
|
||||
# 安装特定技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow --skill prd-generator
|
||||
|
||||
# 列出所有技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/product-manager-workflow --list
|
||||
```
|
||||
|
||||
## 链接
|
||||
|
||||
- [在 GitHub 上查看](https://github.com/nicepkg/ai-workflow/tree/main/workflows/product-manager-workflow)
|
||||
- [贡献指南](/zh/docs/contributing)
|
||||
@@ -0,0 +1,63 @@
|
||||
---
|
||||
title: 股票交易员工作流
|
||||
description: 为金融分析师和交易员预配置的技能集合
|
||||
---
|
||||
|
||||
# 股票交易员工作流
|
||||
|
||||
为金融分析师、交易员和投资研究员提供的 29 个专业技能集合,覆盖美股、A股、港股和台股市场。
|
||||
|
||||
## 目标用户
|
||||
|
||||
- 股票交易员
|
||||
- 金融分析师
|
||||
- 投资研究员
|
||||
- 投资组合经理
|
||||
- 量化分析师
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow
|
||||
```
|
||||
|
||||
## 包含的技能
|
||||
|
||||
`akshare` `股票分析` `stock-screener` `shioaji` `us-stock-analysis` `a-share-analysis` `hk-stock-analysis` `technical-analyst` `china-macro-analyst` `cross-border-flow-tracker` `a-share-screener` `portfolio-manager` `earnings-calendar` `market-news-analyst` `canslim-screener` `value-dividend-screener` `sector-analyst` `options-strategy-advisor` `backtest-expert` `scenario-analyzer` `institutional-flow-tracker` `market-environment-analysis` `breadth-chart-analyst` `pair-trade-screener` `dividend-growth-pullback-screener` `economic-calendar-fetcher` `weekly-trade-strategy` `us-market-bubble-detector` `stanley-druckenmiller-investment`
|
||||
|
||||
## 核心能力
|
||||
|
||||
- **市场分析** - 美股、A股、港股分析
|
||||
- **技术分析** - 图表形态、技术指标、广度分析
|
||||
- **基本面分析** - CANSLIM、价值投资、股息筛选
|
||||
- **投资组合管理** - 资产配置、回测、情景分析
|
||||
- **市场情报** - 新闻分析、机构资金流向、宏观分析
|
||||
|
||||
## 支持的市场
|
||||
|
||||
- **美股市场** - NYSE、NASDAQ
|
||||
- **中国 A 股** - 上海、深圳
|
||||
- **香港** - 港交所
|
||||
- **台湾** - 台湾证券交易所
|
||||
|
||||
## 免责声明
|
||||
|
||||
本工作流仅提供研究和分析工具,不构成投资建议。在做出投资决策前,请务必咨询合格的金融专业人士。
|
||||
|
||||
## 高级选项
|
||||
|
||||
```bash
|
||||
# 全局安装
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow --global
|
||||
|
||||
# 安装特定技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow --skill a-share-analysis
|
||||
|
||||
# 列出所有技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/stock-trader-workflow --list
|
||||
```
|
||||
|
||||
## 链接
|
||||
|
||||
- [在 GitHub 上查看](https://github.com/nicepkg/ai-workflow/tree/main/workflows/stock-trader-workflow)
|
||||
- [贡献指南](/zh/docs/contributing)
|
||||
@@ -0,0 +1,73 @@
|
||||
---
|
||||
title: Talk to Slidev 工作流
|
||||
description: 为主题演讲者和演示文稿创作者预配置的技能集合
|
||||
---
|
||||
|
||||
# Talk to Slidev 工作流
|
||||
|
||||
为主题演讲者、技术大会讲者和教育工作者设计的 18 个专业技能集合,用于创建精美的 Slidev 演示文稿。
|
||||
|
||||
## 目标用户
|
||||
|
||||
- 主题演讲者
|
||||
- 技术大会讲者
|
||||
- 创业者(路演 Pitch Deck)
|
||||
- 教育工作者和培训师
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow
|
||||
```
|
||||
|
||||
## 包含的技能
|
||||
|
||||
`storyline-builder` `presentation-builder` `ppt-creator` `presentation-generator` `theme-factory` `presentation-design-enhancer` `color-palette-extractor` `font-pairing-suggester` `canvas-design` `pexels-media` `nano-banana-pro` `youtube-transcript` `transcribe-and-analyze` `mermaid-diagrams` `mermaid-tools` `infographic-creation` `pptx` `social-repurposer`
|
||||
|
||||
## 核心能力
|
||||
|
||||
### 创意到叙事结构
|
||||
- **storyline-builder** - 麦肯锡 MECE 叙事框架
|
||||
- **presentation-builder** - 通用演示结构
|
||||
|
||||
### 脚本与演讲备注
|
||||
- **ppt-creator** - 完整的演讲稿和演讲备注
|
||||
- **presentation-generator** - HTML 演示文稿生成
|
||||
|
||||
### 视觉主题与设计
|
||||
- **theme-factory** - 一键主题选择
|
||||
- **presentation-design-enhancer** - 将要点转化为视觉效果
|
||||
- **color-palette-extractor** - 从图片提取配色方案
|
||||
- **font-pairing-suggester** - 专业字体搭配
|
||||
|
||||
### 媒体与素材
|
||||
- **pexels-media** - 查找免版权图片和视频
|
||||
- **nano-banana-pro** - AI 生成插图
|
||||
- **youtube-transcript** - 从 YouTube 提取内容
|
||||
|
||||
### 图表与信息图
|
||||
- **mermaid-diagrams** - 流程图、架构图
|
||||
- **mermaid-tools** - 高级 Mermaid 编辑
|
||||
- **infographic-creation** - 将文本转化为信息图
|
||||
|
||||
### 导出与复用
|
||||
- **pptx** - 导出为 PowerPoint 格式
|
||||
- **social-repurposer** - 将幻灯片复用到社交媒体
|
||||
|
||||
## 高级选项
|
||||
|
||||
```bash
|
||||
# 全局安装
|
||||
npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow --global
|
||||
|
||||
# 安装特定技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow --skill ppt-creator
|
||||
|
||||
# 列出所有技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/talk-to-slidev-workflow --list
|
||||
```
|
||||
|
||||
## 链接
|
||||
|
||||
- [在 GitHub 上查看](https://github.com/nicepkg/ai-workflow/tree/main/workflows/talk-to-slidev-workflow)
|
||||
- [贡献指南](/zh/docs/contributing)
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: 视频创作者工作流
|
||||
description: 为视频制作人和内容创作者预配置的技能集合
|
||||
---
|
||||
|
||||
# 视频创作者工作流
|
||||
|
||||
为视频制作人、YouTube 创作者和多媒体内容团队提供的 29 个专业技能集合。
|
||||
|
||||
## 目标用户
|
||||
|
||||
- YouTube 创作者
|
||||
- TikTok 内容创作者
|
||||
- 视频制作人
|
||||
- 播客主持人
|
||||
- 直播内容创作者
|
||||
|
||||
## 安装
|
||||
|
||||
```bash
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow
|
||||
```
|
||||
|
||||
## 包含的技能
|
||||
|
||||
`serpapi` `content-trend-researcher` `content-research` `capture-triage` `youtube-transcript` `youtube-to-markdown` `transcribe-and-analyze` `video-downloader` `tapestry` `video-script-writer` `video-script-collaborial` `video-hook-generator` `video-title-optimizer` `thumbnail-concept-generator` `canvas-design` `pexels-media` `media-processing` `video-to-gif` `youtube-seo-optimizer` `short-form-converter` `social-repurposer` `srt-translator` `instagram` `video-analytics-interpreter` `posthog-analytics` `webfluence` `sponsor-pitch-generator` `video-comparer` `n8n-skills`
|
||||
|
||||
## 核心能力
|
||||
|
||||
- **研究** - 趋势分析、内容研究、竞争对手分析
|
||||
- **制作** - 脚本撰写、缩略图概念、视频钩子
|
||||
- **优化** - YouTube SEO、标题优化、数据分析
|
||||
- **复用** - 短视频转换、社交媒体适配
|
||||
- **变现** - 赞助商推荐、数据分析解读
|
||||
|
||||
## 高级选项
|
||||
|
||||
```bash
|
||||
# 全局安装
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow --global
|
||||
|
||||
# 安装特定技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow --skill video-script-writer
|
||||
|
||||
# 列出所有技能
|
||||
npx add-skill nicepkg/ai-workflow/workflows/video-creator-workflow --list
|
||||
```
|
||||
|
||||
## 链接
|
||||
|
||||
- [在 GitHub 上查看](https://github.com/nicepkg/ai-workflow/tree/main/workflows/video-creator-workflow)
|
||||
- [贡献指南](/zh/docs/contributing)
|
||||
@@ -0,0 +1,10 @@
|
||||
import { useMDXComponents as getDocsMDXComponents } from "nextra-theme-docs";
|
||||
|
||||
const docsComponents = getDocsMDXComponents();
|
||||
|
||||
export function useMDXComponents(components?: Record<string, React.ComponentType>) {
|
||||
return {
|
||||
...docsComponents,
|
||||
...components,
|
||||
};
|
||||
}
|
||||
+40
-7
@@ -1,12 +1,45 @@
|
||||
/**
|
||||
* Run `build` or `dev` with `SKIP_ENV_VALIDATION` to skip env validation. This is especially useful
|
||||
* for Docker builds.
|
||||
*/
|
||||
import "./src/env.js";
|
||||
import nextra from "nextra";
|
||||
|
||||
const withNextra = nextra({
|
||||
// Nextra config options
|
||||
defaultShowCopyCode: true,
|
||||
search: {
|
||||
codeblocks: false,
|
||||
},
|
||||
});
|
||||
|
||||
/** @type {import("next").NextConfig} */
|
||||
const config = {
|
||||
output: "standalone",
|
||||
// Static export for Cloudflare Pages (no server functions)
|
||||
output: "export",
|
||||
|
||||
// Required for static export
|
||||
images: {
|
||||
unoptimized: true,
|
||||
},
|
||||
|
||||
// Trailing slash for better static hosting compatibility
|
||||
trailingSlash: true,
|
||||
|
||||
// Disable x-powered-by header
|
||||
poweredByHeader: false,
|
||||
|
||||
// Enable React strict mode
|
||||
reactStrictMode: true,
|
||||
|
||||
// Eslint config
|
||||
eslint: {
|
||||
// Warning: This allows production builds to successfully complete even if
|
||||
// your project has ESLint errors.
|
||||
ignoreDuringBuilds: true,
|
||||
},
|
||||
|
||||
// TypeScript config
|
||||
typescript: {
|
||||
// Warning: This allows production builds to successfully complete even if
|
||||
// your project has type errors.
|
||||
ignoreBuildErrors: true,
|
||||
},
|
||||
};
|
||||
|
||||
export default config;
|
||||
export default withNextra(config);
|
||||
|
||||
@@ -55,6 +55,8 @@
|
||||
"lucide-react": "^0.562.0",
|
||||
"next": "^15.2.3",
|
||||
"next-themes": "^0.4.6",
|
||||
"nextra": "^4.6.1",
|
||||
"nextra-theme-docs": "^4.6.1",
|
||||
"react": "^19.2.3",
|
||||
"react-day-picker": "^9.13.0",
|
||||
"react-dom": "^19.2.3",
|
||||
|
||||
@@ -0,0 +1,4 @@
|
||||
User-agent: *
|
||||
Allow: /
|
||||
|
||||
Sitemap: https://ai-workflow.xiaominglab.com/sitemap.xml
|
||||
@@ -0,0 +1,32 @@
|
||||
/* eslint-disable react-hooks/rules-of-hooks */
|
||||
/* eslint-disable @typescript-eslint/unbound-method */
|
||||
import { generateStaticParamsFor, importPage } from "nextra/pages";
|
||||
import { useMDXComponents as getMDXComponents } from "../../../mdx-components";
|
||||
|
||||
export const generateStaticParams = generateStaticParamsFor("mdxPath");
|
||||
|
||||
export async function generateMetadata(props: PageProps) {
|
||||
const params = await props.params;
|
||||
const { metadata } = await importPage(params.mdxPath);
|
||||
return metadata;
|
||||
}
|
||||
|
||||
type PageProps = {
|
||||
params: Promise<{
|
||||
mdxPath?: string[];
|
||||
}>;
|
||||
};
|
||||
|
||||
const Wrapper = getMDXComponents().wrapper;
|
||||
|
||||
export default async function Page(props: PageProps) {
|
||||
const params = await props.params;
|
||||
const result = await importPage(params.mdxPath);
|
||||
const { default: MDXContent, toc, metadata } = result;
|
||||
|
||||
return (
|
||||
<Wrapper toc={toc} metadata={metadata}>
|
||||
<MDXContent {...props} params={params} />
|
||||
</Wrapper>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,97 @@
|
||||
import type { Metadata } from "next";
|
||||
import { Footer, Layout, Navbar } from "nextra-theme-docs";
|
||||
import { Banner, Head } from "nextra/components";
|
||||
import { getPageMap } from "nextra/page-map";
|
||||
import "nextra-theme-docs/style.css";
|
||||
import "../styles/globals.css";
|
||||
|
||||
export const metadata: Metadata = {
|
||||
title: {
|
||||
default: "AI Workflow",
|
||||
template: "%s - AI Workflow",
|
||||
},
|
||||
description: "Pre-configured skill sets for AI coding assistants like Claude Code, Cursor, Codex, and more.",
|
||||
metadataBase: new URL("https://ai-workflow.xiaominglab.com"),
|
||||
openGraph: {
|
||||
title: "AI Workflow",
|
||||
description: "Pre-configured skill sets for AI coding assistants",
|
||||
url: "https://ai-workflow.xiaominglab.com",
|
||||
siteName: "AI Workflow",
|
||||
locale: "en_US",
|
||||
type: "website",
|
||||
},
|
||||
twitter: {
|
||||
card: "summary_large_image",
|
||||
title: "AI Workflow",
|
||||
description: "Pre-configured skill sets for AI coding assistants",
|
||||
},
|
||||
robots: {
|
||||
index: true,
|
||||
follow: true,
|
||||
},
|
||||
};
|
||||
|
||||
const logo = (
|
||||
<span style={{ fontWeight: 700 }}>
|
||||
AI Workflow
|
||||
</span>
|
||||
);
|
||||
|
||||
const footerContent = (
|
||||
<span>
|
||||
MIT {new Date().getFullYear()} ©{" "}
|
||||
<a href="https://github.com/nicepkg/ai-workflow" target="_blank" rel="noopener noreferrer">
|
||||
AI Workflow
|
||||
</a>
|
||||
</span>
|
||||
);
|
||||
|
||||
export default async function RootLayout({
|
||||
children,
|
||||
}: {
|
||||
children: React.ReactNode;
|
||||
}) {
|
||||
const pageMap = await getPageMap();
|
||||
|
||||
return (
|
||||
<html lang="en" dir="ltr" suppressHydrationWarning>
|
||||
<Head faviconGlyph="AI" />
|
||||
<body>
|
||||
<Layout
|
||||
pageMap={pageMap}
|
||||
docsRepositoryBase="https://github.com/nicepkg/ai-workflow/tree/main/website/content"
|
||||
editLink="Edit this page on GitHub"
|
||||
sidebar={{
|
||||
defaultMenuCollapseLevel: 1,
|
||||
toggleButton: true,
|
||||
}}
|
||||
toc={{
|
||||
backToTop: true,
|
||||
}}
|
||||
feedback={{
|
||||
content: "Question? Give us feedback",
|
||||
labels: "feedback",
|
||||
}}
|
||||
i18n={[
|
||||
{ locale: "en", name: "English" },
|
||||
{ locale: "zh", name: "中文" },
|
||||
]}
|
||||
navbar={
|
||||
<Navbar
|
||||
logo={logo}
|
||||
projectLink="https://github.com/nicepkg/ai-workflow"
|
||||
/>
|
||||
}
|
||||
footer={<Footer>{footerContent}</Footer>}
|
||||
banner={
|
||||
<Banner storageKey="ai-workflow-banner">
|
||||
AI Workflow is now open source! Star us on GitHub
|
||||
</Banner>
|
||||
}
|
||||
>
|
||||
{children}
|
||||
</Layout>
|
||||
</body>
|
||||
</html>
|
||||
);
|
||||
}
|
||||
@@ -1,10 +0,0 @@
|
||||
import type { MetadataRoute } from "next";
|
||||
|
||||
export default function robots(): MetadataRoute.Robots {
|
||||
return {
|
||||
rules: {
|
||||
userAgent: "*",
|
||||
allow: "/",
|
||||
},
|
||||
};
|
||||
}
|
||||
+12
-18
@@ -3,41 +3,35 @@ import { z } from "zod";
|
||||
|
||||
export const env = createEnv({
|
||||
/**
|
||||
* Specify your server-side environment variables schema here. This way you can ensure the app
|
||||
* isn't built with invalid env vars.
|
||||
* For static export, we only use client-side environment variables.
|
||||
* Server-side variables are not available in static builds.
|
||||
*/
|
||||
server: {
|
||||
SUPPORT_EMAIL: z.string().email().optional(),
|
||||
NODE_ENV: z.enum(["development", "test", "production"]).default("development"),
|
||||
},
|
||||
server: {},
|
||||
|
||||
/**
|
||||
* Specify your client-side environment variables schema here. This way you can ensure the app
|
||||
* isn't built with invalid env vars. To expose them to the client, prefix them with
|
||||
* `NEXT_PUBLIC_`.
|
||||
* Specify your client-side environment variables schema here.
|
||||
* To expose them to the client, prefix them with `NEXT_PUBLIC_`.
|
||||
*/
|
||||
client: {
|
||||
// NEXT_PUBLIC_CLIENTVAR: z.string(),
|
||||
NEXT_PUBLIC_SITE_URL: z.string().url().optional(),
|
||||
NEXT_PUBLIC_GIT_SHA: z.string().optional(),
|
||||
},
|
||||
|
||||
/**
|
||||
* You can't destruct `process.env` as a regular object in the Next.js edge runtimes (e.g.
|
||||
* middlewares) or client-side so we need to destruct manually.
|
||||
* Runtime environment mapping.
|
||||
*/
|
||||
runtimeEnv: {
|
||||
SUPPORT_EMAIL: process.env.SUPPORT_EMAIL,
|
||||
NODE_ENV: process.env.NODE_ENV,
|
||||
NEXT_PUBLIC_SITE_URL: process.env.NEXT_PUBLIC_SITE_URL,
|
||||
NEXT_PUBLIC_GIT_SHA: process.env.NEXT_PUBLIC_GIT_SHA,
|
||||
},
|
||||
|
||||
/**
|
||||
* Run `build` or `dev` with `SKIP_ENV_VALIDATION` to skip env validation. This is especially
|
||||
* useful for Docker builds.
|
||||
* Skip validation during build if needed.
|
||||
*/
|
||||
skipValidation: !!process.env.SKIP_ENV_VALIDATION,
|
||||
|
||||
/**
|
||||
* Makes it so that empty strings are treated as undefined. `SOME_VAR: z.string()` and
|
||||
* `SOME_VAR=''` will throw an error.
|
||||
* Empty strings are treated as undefined.
|
||||
*/
|
||||
emptyStringAsUndefined: true,
|
||||
});
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
import { env } from "~/env";
|
||||
export const supportEmail = "2214962083@qq.com";
|
||||
|
||||
export const supportEmail = env.SUPPORT_EMAIL?.trim() || "2214962083@qq.com";
|
||||
export const siteConfig = {
|
||||
name: "AI Workflow",
|
||||
description: "Pre-configured skill sets for AI coding assistants",
|
||||
url: "https://ai-workflow.xiaominglab.com",
|
||||
github: "https://github.com/nicepkg/ai-workflow",
|
||||
};
|
||||
|
||||
@@ -0,0 +1,72 @@
|
||||
import type { ReactNode } from "react";
|
||||
|
||||
interface ThemeConfig {
|
||||
logo: ReactNode;
|
||||
project: {
|
||||
link: string;
|
||||
};
|
||||
docsRepositoryBase: string;
|
||||
footer: {
|
||||
content: ReactNode;
|
||||
};
|
||||
editLink: {
|
||||
content: string;
|
||||
};
|
||||
sidebar: {
|
||||
defaultMenuCollapseLevel: number;
|
||||
toggleButton: boolean;
|
||||
};
|
||||
toc: {
|
||||
backToTop: boolean;
|
||||
};
|
||||
i18n: Array<{
|
||||
locale: string;
|
||||
name: string;
|
||||
}>;
|
||||
feedback: {
|
||||
content: string;
|
||||
labels: string;
|
||||
};
|
||||
}
|
||||
|
||||
const config: ThemeConfig = {
|
||||
logo: (
|
||||
<span style={{ fontWeight: 700 }}>
|
||||
AI Workflow
|
||||
</span>
|
||||
),
|
||||
project: {
|
||||
link: "https://github.com/nicepkg/ai-workflow",
|
||||
},
|
||||
docsRepositoryBase: "https://github.com/nicepkg/ai-workflow/tree/main/website/content",
|
||||
footer: {
|
||||
content: (
|
||||
<span>
|
||||
MIT {new Date().getFullYear()} ©{" "}
|
||||
<a href="https://github.com/nicepkg/ai-workflow" target="_blank" rel="noopener noreferrer">
|
||||
AI Workflow
|
||||
</a>
|
||||
</span>
|
||||
),
|
||||
},
|
||||
editLink: {
|
||||
content: "Edit this page on GitHub",
|
||||
},
|
||||
sidebar: {
|
||||
defaultMenuCollapseLevel: 1,
|
||||
toggleButton: true,
|
||||
},
|
||||
toc: {
|
||||
backToTop: true,
|
||||
},
|
||||
i18n: [
|
||||
{ locale: "en", name: "English" },
|
||||
{ locale: "zh", name: "中文" },
|
||||
],
|
||||
feedback: {
|
||||
content: "Question? Give us feedback",
|
||||
labels: "feedback",
|
||||
},
|
||||
};
|
||||
|
||||
export default config;
|
||||
Reference in New Issue
Block a user