@macpaw/cctk 1.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/License +21 -0
- package/README.md +142 -0
- package/bin/index.js +5 -0
- package/dist/index.js +1 -0
- package/package.json +65 -0
- package/templates/claude/agents/brainstormer.md +113 -0
- package/templates/claude/agents/code-reviewer.md +157 -0
- package/templates/claude/agents/copywriter.md +110 -0
- package/templates/claude/agents/database-admin.md +92 -0
- package/templates/claude/agents/debugger.md +137 -0
- package/templates/claude/agents/docs-manager.md +208 -0
- package/templates/claude/agents/fullstack-developer.md +95 -0
- package/templates/claude/agents/git-manager.md +394 -0
- package/templates/claude/agents/journal-writer.md +113 -0
- package/templates/claude/agents/mcp-manager.md +89 -0
- package/templates/claude/agents/planner.md +108 -0
- package/templates/claude/agents/project-manager.md +125 -0
- package/templates/claude/agents/registry.json +304 -0
- package/templates/claude/agents/researcher.md +37 -0
- package/templates/claude/agents/scout-external.md +140 -0
- package/templates/claude/agents/scout.md +106 -0
- package/templates/claude/agents/tester.md +105 -0
- package/templates/claude/agents/ui-ux-designer.md +208 -0
- package/templates/claude/commands/ask.md +56 -0
- package/templates/claude/commands/bootstrap/auto/fast.md +106 -0
- package/templates/claude/commands/bootstrap/auto/parallel.md +64 -0
- package/templates/claude/commands/bootstrap/auto.md +110 -0
- package/templates/claude/commands/bootstrap.md +130 -0
- package/templates/claude/commands/brainstorm.md +75 -0
- package/templates/claude/commands/code/auto.md +198 -0
- package/templates/claude/commands/code/no-test.md +172 -0
- package/templates/claude/commands/code/parallel.md +100 -0
- package/templates/claude/commands/code.md +197 -0
- package/templates/claude/commands/coding-level.md +37 -0
- package/templates/claude/commands/content/cro.md +41 -0
- package/templates/claude/commands/content/enhance.md +12 -0
- package/templates/claude/commands/content/fast.md +11 -0
- package/templates/claude/commands/content/good.md +14 -0
- package/templates/claude/commands/cook/auto/fast.md +26 -0
- package/templates/claude/commands/cook/auto/parallel.md +49 -0
- package/templates/claude/commands/cook/auto.md +15 -0
- package/templates/claude/commands/cook.md +101 -0
- package/templates/claude/commands/debug.md +13 -0
- package/templates/claude/commands/docs/init.md +37 -0
- package/templates/claude/commands/docs/summarize.md +22 -0
- package/templates/claude/commands/docs/update.md +78 -0
- package/templates/claude/commands/fix/ci.md +17 -0
- package/templates/claude/commands/fix/fast.md +18 -0
- package/templates/claude/commands/fix/hard.md +35 -0
- package/templates/claude/commands/fix/logs.md +26 -0
- package/templates/claude/commands/fix/parallel.md +54 -0
- package/templates/claude/commands/fix/test.md +20 -0
- package/templates/claude/commands/fix/types.md +9 -0
- package/templates/claude/commands/fix/ui.md +33 -0
- package/templates/claude/commands/fix.md +43 -0
- package/templates/claude/commands/git/cm.md +5 -0
- package/templates/claude/commands/git/cp.md +4 -0
- package/templates/claude/commands/git/merge.md +40 -0
- package/templates/claude/commands/git/pr.md +50 -0
- package/templates/claude/commands/journal.md +7 -0
- package/templates/claude/commands/kanban.md +99 -0
- package/templates/claude/commands/plan/archive.md +57 -0
- package/templates/claude/commands/plan/ci.md +33 -0
- package/templates/claude/commands/plan/cro.md +67 -0
- package/templates/claude/commands/plan/fast.md +66 -0
- package/templates/claude/commands/plan/hard.md +92 -0
- package/templates/claude/commands/plan/parallel.md +129 -0
- package/templates/claude/commands/plan/two.md +45 -0
- package/templates/claude/commands/plan/validate.md +117 -0
- package/templates/claude/commands/plan.md +30 -0
- package/templates/claude/commands/preview.md +87 -0
- package/templates/claude/commands/registry.json +313 -0
- package/templates/claude/commands/review/codebase/parallel.md +122 -0
- package/templates/claude/commands/review/codebase.md +47 -0
- package/templates/claude/commands/scout/ext.md +35 -0
- package/templates/claude/commands/scout.md +28 -0
- package/templates/claude/commands/skill/add.md +36 -0
- package/templates/claude/commands/skill/create.md +29 -0
- package/templates/claude/commands/skill/fix-logs.md +22 -0
- package/templates/claude/commands/skill/optimize/auto.md +25 -0
- package/templates/claude/commands/skill/optimize.md +34 -0
- package/templates/claude/commands/skill/plan.md +45 -0
- package/templates/claude/commands/test/ui.md +91 -0
- package/templates/claude/commands/test.md +8 -0
- package/templates/claude/commands/use-mcp.md +34 -0
- package/templates/claude/commands/watzup.md +8 -0
- package/templates/claude/commands/worktree.md +126 -0
- package/templates/claude/hooks/dev-rules-reminder.cjs +258 -0
- package/templates/claude/hooks/docs/README.md +42 -0
- package/templates/claude/hooks/lib/cctk-config-utils.cjs +751 -0
- package/templates/claude/hooks/lib/cctk-paths.cjs +106 -0
- package/templates/claude/hooks/lib/context-tracker.cjs +346 -0
- package/templates/claude/hooks/privacy-block.cjs +289 -0
- package/templates/claude/hooks/registry.json +77 -0
- package/templates/claude/hooks/scout-block/broad-pattern-detector.cjs +293 -0
- package/templates/claude/hooks/scout-block/error-formatter.cjs +156 -0
- package/templates/claude/hooks/scout-block/path-extractor.cjs +359 -0
- package/templates/claude/hooks/scout-block/pattern-matcher.cjs +184 -0
- package/templates/claude/hooks/scout-block/vendor/ignore.js +626 -0
- package/templates/claude/hooks/scout-block.cjs +167 -0
- package/templates/claude/hooks/session-end.cjs +35 -0
- package/templates/claude/hooks/session-init.cjs +214 -0
- package/templates/claude/hooks/subagent-init.cjs +161 -0
- package/templates/claude/hooks/write-compact-marker.cjs +153 -0
- package/templates/claude/output-styles/coding-level-1.md +148 -0
- package/templates/claude/output-styles/coding-level-2.md +159 -0
- package/templates/claude/output-styles/coding-level-3.md +91 -0
- package/templates/claude/scripts/README.md +33 -0
- package/templates/claude/scripts/generate-catalogs.cjs +318 -0
- package/templates/claude/scripts/registry.json +48 -0
- package/templates/claude/scripts/set-active-plan.cjs +45 -0
- package/templates/claude/scripts/validate-docs.cjs +447 -0
- package/templates/claude/scripts/worktree.cjs +658 -0
- package/templates/claude/skills/README.md +112 -0
- package/templates/claude/skills/ai-artist/SKILL.md +75 -0
- package/templates/claude/skills/ai-artist/references/advanced-techniques.md +184 -0
- package/templates/claude/skills/ai-artist/references/domain-code.md +66 -0
- package/templates/claude/skills/ai-artist/references/domain-data.md +72 -0
- package/templates/claude/skills/ai-artist/references/domain-marketing.md +66 -0
- package/templates/claude/skills/ai-artist/references/domain-patterns.md +33 -0
- package/templates/claude/skills/ai-artist/references/domain-writing.md +68 -0
- package/templates/claude/skills/ai-artist/references/image-prompting.md +141 -0
- package/templates/claude/skills/ai-artist/references/llm-prompting.md +165 -0
- package/templates/claude/skills/ai-artist/references/nano-banana.md +59 -0
- package/templates/claude/skills/ai-artist/references/reasoning-techniques.md +201 -0
- package/templates/claude/skills/backend-development/SKILL.md +95 -0
- package/templates/claude/skills/backend-development/references/backend-api-design.md +495 -0
- package/templates/claude/skills/backend-development/references/backend-architecture.md +454 -0
- package/templates/claude/skills/backend-development/references/backend-authentication.md +338 -0
- package/templates/claude/skills/backend-development/references/backend-code-quality.md +659 -0
- package/templates/claude/skills/backend-development/references/backend-debugging.md +904 -0
- package/templates/claude/skills/backend-development/references/backend-devops.md +494 -0
- package/templates/claude/skills/backend-development/references/backend-mindset.md +387 -0
- package/templates/claude/skills/backend-development/references/backend-performance.md +397 -0
- package/templates/claude/skills/backend-development/references/backend-security.md +290 -0
- package/templates/claude/skills/backend-development/references/backend-technologies.md +256 -0
- package/templates/claude/skills/backend-development/references/backend-testing.md +429 -0
- package/templates/claude/skills/better-auth/SKILL.md +204 -0
- package/templates/claude/skills/better-auth/references/advanced-features.md +553 -0
- package/templates/claude/skills/better-auth/references/database-integration.md +577 -0
- package/templates/claude/skills/better-auth/references/email-password-auth.md +416 -0
- package/templates/claude/skills/better-auth/references/oauth-providers.md +430 -0
- package/templates/claude/skills/better-auth/scripts/better_auth_init.py +521 -0
- package/templates/claude/skills/chrome-devtools/SKILL.md +473 -0
- package/templates/claude/skills/chrome-devtools/references/cdp-domains.md +694 -0
- package/templates/claude/skills/chrome-devtools/references/performance-guide.md +940 -0
- package/templates/claude/skills/chrome-devtools/references/puppeteer-reference.md +953 -0
- package/templates/claude/skills/chrome-devtools/scripts/README.md +288 -0
- package/templates/claude/skills/chrome-devtools/scripts/aria-snapshot.js +368 -0
- package/templates/claude/skills/chrome-devtools/scripts/click.js +92 -0
- package/templates/claude/skills/chrome-devtools/scripts/console.js +85 -0
- package/templates/claude/skills/chrome-devtools/scripts/evaluate.js +59 -0
- package/templates/claude/skills/chrome-devtools/scripts/fill.js +84 -0
- package/templates/claude/skills/chrome-devtools/scripts/inject-auth.js +247 -0
- package/templates/claude/skills/chrome-devtools/scripts/install-deps.sh +11 -0
- package/templates/claude/skills/chrome-devtools/scripts/install.sh +36 -0
- package/templates/claude/skills/chrome-devtools/scripts/lib/browser.js +335 -0
- package/templates/claude/skills/chrome-devtools/scripts/lib/selector.js +183 -0
- package/templates/claude/skills/chrome-devtools/scripts/navigate.js +60 -0
- package/templates/claude/skills/chrome-devtools/scripts/network.js +113 -0
- package/templates/claude/skills/chrome-devtools/scripts/package.json +16 -0
- package/templates/claude/skills/chrome-devtools/scripts/performance.js +159 -0
- package/templates/claude/skills/chrome-devtools/scripts/screenshot.js +212 -0
- package/templates/claude/skills/chrome-devtools/scripts/select-ref.js +151 -0
- package/templates/claude/skills/chrome-devtools/scripts/snapshot.js +143 -0
- package/templates/claude/skills/chrome-devtools/scripts/ws-debug.js +47 -0
- package/templates/claude/skills/chrome-devtools/scripts/ws-full-debug.js +115 -0
- package/templates/claude/skills/claude-code/references/advanced-features.md +399 -0
- package/templates/claude/skills/claude-code/references/agent-skills.md +399 -0
- package/templates/claude/skills/claude-code/references/api-reference.md +498 -0
- package/templates/claude/skills/claude-code/references/best-practices.md +447 -0
- package/templates/claude/skills/claude-code/references/cicd-integration.md +428 -0
- package/templates/claude/skills/claude-code/references/common-workflows.md +107 -0
- package/templates/claude/skills/claude-code/references/configuration.md +480 -0
- package/templates/claude/skills/claude-code/references/enterprise-features.md +472 -0
- package/templates/claude/skills/claude-code/references/getting-started.md +244 -0
- package/templates/claude/skills/claude-code/references/hooks-and-plugins.md +444 -0
- package/templates/claude/skills/claude-code/references/hooks-comprehensive.md +622 -0
- package/templates/claude/skills/claude-code/references/ide-integration.md +316 -0
- package/templates/claude/skills/claude-code/references/mcp-integration.md +386 -0
- package/templates/claude/skills/claude-code/references/slash-commands.md +460 -0
- package/templates/claude/skills/claude-code/references/troubleshooting.md +455 -0
- package/templates/claude/skills/claude-code/skill.md +60 -0
- package/templates/claude/skills/code-review/SKILL.md +143 -0
- package/templates/claude/skills/code-review/references/code-review-reception.md +209 -0
- package/templates/claude/skills/code-review/references/requesting-code-review.md +105 -0
- package/templates/claude/skills/code-review/references/verification-before-completion.md +139 -0
- package/templates/claude/skills/context-engineering/SKILL.md +86 -0
- package/templates/claude/skills/context-engineering/references/context-compression.md +84 -0
- package/templates/claude/skills/context-engineering/references/context-degradation.md +93 -0
- package/templates/claude/skills/context-engineering/references/context-fundamentals.md +75 -0
- package/templates/claude/skills/context-engineering/references/context-optimization.md +82 -0
- package/templates/claude/skills/context-engineering/references/evaluation.md +89 -0
- package/templates/claude/skills/context-engineering/references/memory-systems.md +88 -0
- package/templates/claude/skills/context-engineering/references/multi-agent-patterns.md +90 -0
- package/templates/claude/skills/context-engineering/references/project-development.md +97 -0
- package/templates/claude/skills/context-engineering/references/tool-design.md +86 -0
- package/templates/claude/skills/context-engineering/scripts/compression_evaluator.py +329 -0
- package/templates/claude/skills/context-engineering/scripts/context_analyzer.py +294 -0
- package/templates/claude/skills/databases/SKILL.md +232 -0
- package/templates/claude/skills/databases/references/mongodb-aggregation.md +447 -0
- package/templates/claude/skills/databases/references/mongodb-atlas.md +465 -0
- package/templates/claude/skills/databases/references/mongodb-crud.md +408 -0
- package/templates/claude/skills/databases/references/mongodb-indexing.md +442 -0
- package/templates/claude/skills/databases/references/postgresql-administration.md +594 -0
- package/templates/claude/skills/databases/references/postgresql-performance.md +527 -0
- package/templates/claude/skills/databases/references/postgresql-psql-cli.md +467 -0
- package/templates/claude/skills/databases/references/postgresql-queries.md +475 -0
- package/templates/claude/skills/databases/scripts/db_backup.py +502 -0
- package/templates/claude/skills/databases/scripts/db_migrate.py +414 -0
- package/templates/claude/skills/databases/scripts/db_performance_check.py +445 -0
- package/templates/claude/skills/debugging/SKILL.md +84 -0
- package/templates/claude/skills/debugging/references/defense-in-depth.md +124 -0
- package/templates/claude/skills/debugging/references/root-cause-tracing.md +122 -0
- package/templates/claude/skills/debugging/references/systematic-debugging.md +102 -0
- package/templates/claude/skills/debugging/references/verification.md +123 -0
- package/templates/claude/skills/debugging/scripts/find-polluter.sh +63 -0
- package/templates/claude/skills/debugging/scripts/find-polluter.test.md +102 -0
- package/templates/claude/skills/devops/SKILL.md +293 -0
- package/templates/claude/skills/devops/references/browser-rendering.md +305 -0
- package/templates/claude/skills/devops/references/cloudflare-d1-kv.md +123 -0
- package/templates/claude/skills/devops/references/cloudflare-platform.md +271 -0
- package/templates/claude/skills/devops/references/cloudflare-r2-storage.md +280 -0
- package/templates/claude/skills/devops/references/cloudflare-workers-advanced.md +312 -0
- package/templates/claude/skills/devops/references/cloudflare-workers-apis.md +309 -0
- package/templates/claude/skills/devops/references/cloudflare-workers-basics.md +418 -0
- package/templates/claude/skills/devops/references/docker-basics.md +297 -0
- package/templates/claude/skills/devops/references/docker-compose.md +292 -0
- package/templates/claude/skills/devops/references/gcloud-platform.md +307 -0
- package/templates/claude/skills/devops/references/gcloud-services.md +304 -0
- package/templates/claude/skills/devops/scripts/cloudflare_deploy.py +269 -0
- package/templates/claude/skills/devops/scripts/docker_optimize.py +320 -0
- package/templates/claude/skills/docs-seeker/SKILL.md +95 -0
- package/templates/claude/skills/docs-seeker/package.json +24 -0
- package/templates/claude/skills/docs-seeker/references/advanced.md +78 -0
- package/templates/claude/skills/docs-seeker/references/context7-patterns.md +68 -0
- package/templates/claude/skills/docs-seeker/references/errors.md +68 -0
- package/templates/claude/skills/docs-seeker/scripts/analyze-llms-txt.js +245 -0
- package/templates/claude/skills/docs-seeker/scripts/detect-topic.js +172 -0
- package/templates/claude/skills/docs-seeker/scripts/fetch-docs.js +212 -0
- package/templates/claude/skills/docs-seeker/workflows/library-search.md +87 -0
- package/templates/claude/skills/docs-seeker/workflows/repo-analysis.md +91 -0
- package/templates/claude/skills/docs-seeker/workflows/topic-search.md +77 -0
- package/templates/claude/skills/frontend-design/SKILL.md +85 -0
- package/templates/claude/skills/frontend-design/references/analysis-best-practices.md +80 -0
- package/templates/claude/skills/frontend-design/references/analysis-prompts.md +141 -0
- package/templates/claude/skills/frontend-design/references/analysis-techniques.md +118 -0
- package/templates/claude/skills/frontend-design/references/animejs.md +396 -0
- package/templates/claude/skills/frontend-design/references/design-extraction-overview.md +71 -0
- package/templates/claude/skills/frontend-design/references/extraction-best-practices.md +141 -0
- package/templates/claude/skills/frontend-design/references/extraction-output-templates.md +162 -0
- package/templates/claude/skills/frontend-design/references/extraction-prompts.md +127 -0
- package/templates/claude/skills/frontend-design/references/technical-accessibility.md +119 -0
- package/templates/claude/skills/frontend-design/references/technical-best-practices.md +97 -0
- package/templates/claude/skills/frontend-design/references/technical-optimization.md +44 -0
- package/templates/claude/skills/frontend-design/references/technical-overview.md +90 -0
- package/templates/claude/skills/frontend-design/references/technical-workflows.md +150 -0
- package/templates/claude/skills/frontend-design/references/visual-analysis-overview.md +95 -0
- package/templates/claude/skills/frontend-development/SKILL.md +399 -0
- package/templates/claude/skills/frontend-development/resources/common-patterns.md +331 -0
- package/templates/claude/skills/frontend-development/resources/complete-examples.md +872 -0
- package/templates/claude/skills/frontend-development/resources/component-patterns.md +502 -0
- package/templates/claude/skills/frontend-development/resources/data-fetching.md +767 -0
- package/templates/claude/skills/frontend-development/resources/file-organization.md +502 -0
- package/templates/claude/skills/frontend-development/resources/loading-and-error-states.md +501 -0
- package/templates/claude/skills/frontend-development/resources/performance.md +406 -0
- package/templates/claude/skills/frontend-development/resources/routing-guide.md +364 -0
- package/templates/claude/skills/frontend-development/resources/styling-guide.md +428 -0
- package/templates/claude/skills/frontend-development/resources/typescript-standards.md +418 -0
- package/templates/claude/skills/markdown-novel-viewer/SKILL.md +272 -0
- package/templates/claude/skills/markdown-novel-viewer/assets/directory-browser.css +215 -0
- package/templates/claude/skills/markdown-novel-viewer/assets/favicon.png +0 -0
- package/templates/claude/skills/markdown-novel-viewer/assets/novel-theme.css +872 -0
- package/templates/claude/skills/markdown-novel-viewer/assets/reader.js +378 -0
- package/templates/claude/skills/markdown-novel-viewer/assets/template.html +85 -0
- package/templates/claude/skills/markdown-novel-viewer/package.json +15 -0
- package/templates/claude/skills/markdown-novel-viewer/scripts/lib/http-server.cjs +434 -0
- package/templates/claude/skills/markdown-novel-viewer/scripts/lib/markdown-renderer.cjs +335 -0
- package/templates/claude/skills/markdown-novel-viewer/scripts/lib/plan-navigator.cjs +509 -0
- package/templates/claude/skills/markdown-novel-viewer/scripts/lib/port-finder.cjs +49 -0
- package/templates/claude/skills/markdown-novel-viewer/scripts/lib/process-mgr.cjs +150 -0
- package/templates/claude/skills/markdown-novel-viewer/scripts/server.cjs +398 -0
- package/templates/claude/skills/mcp-builder/SKILL.md +328 -0
- package/templates/claude/skills/mcp-builder/reference/evaluation.md +602 -0
- package/templates/claude/skills/mcp-builder/reference/mcp_best_practices.md +915 -0
- package/templates/claude/skills/mcp-builder/reference/node_mcp_server.md +916 -0
- package/templates/claude/skills/mcp-builder/reference/python_mcp_server.md +752 -0
- package/templates/claude/skills/mcp-builder/scripts/connections.py +151 -0
- package/templates/claude/skills/mcp-builder/scripts/evaluation.py +381 -0
- package/templates/claude/skills/mcp-builder/scripts/example_evaluation.xml +22 -0
- package/templates/claude/skills/mcp-builder/scripts/requirements.txt +2 -0
- package/templates/claude/skills/mcp-management/README.md +219 -0
- package/templates/claude/skills/mcp-management/SKILL.md +209 -0
- package/templates/claude/skills/mcp-management/assets/tools.json +3146 -0
- package/templates/claude/skills/mcp-management/references/configuration.md +114 -0
- package/templates/claude/skills/mcp-management/references/gemini-cli-integration.md +209 -0
- package/templates/claude/skills/mcp-management/references/mcp-protocol.md +116 -0
- package/templates/claude/skills/mcp-management/scripts/.env.example +10 -0
- package/templates/claude/skills/mcp-management/scripts/cli.ts +202 -0
- package/templates/claude/skills/mcp-management/scripts/mcp-client.ts +247 -0
- package/templates/claude/skills/mcp-management/scripts/package.json +20 -0
- package/templates/claude/skills/mcp-management/scripts/tsconfig.json +15 -0
- package/templates/claude/skills/media-processing/SKILL.md +91 -0
- package/templates/claude/skills/media-processing/references/common-workflows.md +132 -0
- package/templates/claude/skills/media-processing/references/ffmpeg-encoding.md +358 -0
- package/templates/claude/skills/media-processing/references/ffmpeg-filters.md +503 -0
- package/templates/claude/skills/media-processing/references/ffmpeg-streaming.md +395 -0
- package/templates/claude/skills/media-processing/references/format-compatibility.md +375 -0
- package/templates/claude/skills/media-processing/references/imagemagick-batch.md +612 -0
- package/templates/claude/skills/media-processing/references/imagemagick-editing.md +623 -0
- package/templates/claude/skills/media-processing/references/rmbg-background-removal.md +66 -0
- package/templates/claude/skills/media-processing/references/troubleshooting.md +109 -0
- package/templates/claude/skills/media-processing/scripts/README.md +102 -0
- package/templates/claude/skills/media-processing/scripts/batch-remove-background.sh +124 -0
- package/templates/claude/skills/media-processing/scripts/batch_resize.py +342 -0
- package/templates/claude/skills/media-processing/scripts/media_convert.py +311 -0
- package/templates/claude/skills/media-processing/scripts/remove-background.sh +96 -0
- package/templates/claude/skills/media-processing/scripts/remove-bg-node.js +181 -0
- package/templates/claude/skills/mermaidjs-v11/SKILL.md +115 -0
- package/templates/claude/skills/mermaidjs-v11/references/cli-usage.md +228 -0
- package/templates/claude/skills/mermaidjs-v11/references/configuration.md +232 -0
- package/templates/claude/skills/mermaidjs-v11/references/diagram-types.md +315 -0
- package/templates/claude/skills/mermaidjs-v11/references/examples.md +344 -0
- package/templates/claude/skills/mermaidjs-v11/references/integration.md +310 -0
- package/templates/claude/skills/planning/SKILL.md +115 -0
- package/templates/claude/skills/planning/references/codebase-understanding.md +62 -0
- package/templates/claude/skills/planning/references/output-standards.md +127 -0
- package/templates/claude/skills/planning/references/plan-organization.md +150 -0
- package/templates/claude/skills/planning/references/research-phase.md +49 -0
- package/templates/claude/skills/planning/references/solution-design.md +63 -0
- package/templates/claude/skills/plans-kanban/SKILL.md +157 -0
- package/templates/claude/skills/plans-kanban/assets/dashboard-template.html +119 -0
- package/templates/claude/skills/plans-kanban/assets/dashboard.css +1594 -0
- package/templates/claude/skills/plans-kanban/assets/dashboard.js +659 -0
- package/templates/claude/skills/plans-kanban/assets/favicon.png +0 -0
- package/templates/claude/skills/plans-kanban/package.json +13 -0
- package/templates/claude/skills/plans-kanban/scripts/lib/dashboard-renderer.cjs +941 -0
- package/templates/claude/skills/plans-kanban/scripts/lib/http-server.cjs +310 -0
- package/templates/claude/skills/plans-kanban/scripts/lib/plan-metadata-extractor.cjs +489 -0
- package/templates/claude/skills/plans-kanban/scripts/lib/plan-parser.cjs +194 -0
- package/templates/claude/skills/plans-kanban/scripts/lib/plan-scanner.cjs +277 -0
- package/templates/claude/skills/plans-kanban/scripts/lib/port-finder.cjs +49 -0
- package/templates/claude/skills/plans-kanban/scripts/lib/process-mgr.cjs +128 -0
- package/templates/claude/skills/plans-kanban/scripts/server.cjs +249 -0
- package/templates/claude/skills/problem-solving/SKILL.md +96 -0
- package/templates/claude/skills/problem-solving/references/attribution.md +69 -0
- package/templates/claude/skills/problem-solving/references/collision-zone-thinking.md +79 -0
- package/templates/claude/skills/problem-solving/references/inversion-exercise.md +91 -0
- package/templates/claude/skills/problem-solving/references/meta-pattern-recognition.md +87 -0
- package/templates/claude/skills/problem-solving/references/scale-game.md +95 -0
- package/templates/claude/skills/problem-solving/references/simplification-cascades.md +80 -0
- package/templates/claude/skills/problem-solving/references/when-stuck.md +72 -0
- package/templates/claude/skills/registry.json +258 -0
- package/templates/claude/skills/repomix/SKILL.md +247 -0
- package/templates/claude/skills/repomix/references/configuration.md +211 -0
- package/templates/claude/skills/repomix/references/usage-patterns.md +232 -0
- package/templates/claude/skills/repomix/scripts/README.md +179 -0
- package/templates/claude/skills/repomix/scripts/repomix_batch.py +455 -0
- package/templates/claude/skills/repomix/scripts/repos.example.json +15 -0
- package/templates/claude/skills/research/SKILL.md +168 -0
- package/templates/claude/skills/sequential-thinking/.env.example +8 -0
- package/templates/claude/skills/sequential-thinking/README.md +183 -0
- package/templates/claude/skills/sequential-thinking/SKILL.md +94 -0
- package/templates/claude/skills/sequential-thinking/package.json +31 -0
- package/templates/claude/skills/sequential-thinking/references/advanced-strategies.md +79 -0
- package/templates/claude/skills/sequential-thinking/references/advanced-techniques.md +76 -0
- package/templates/claude/skills/sequential-thinking/references/core-patterns.md +95 -0
- package/templates/claude/skills/sequential-thinking/references/examples-api.md +88 -0
- package/templates/claude/skills/sequential-thinking/references/examples-architecture.md +94 -0
- package/templates/claude/skills/sequential-thinking/references/examples-debug.md +90 -0
- package/templates/claude/skills/sequential-thinking/scripts/format-thought.js +182 -0
- package/templates/claude/skills/sequential-thinking/scripts/process-thought.js +252 -0
- package/templates/claude/skills/skill-creator/LICENSE.txt +202 -0
- package/templates/claude/skills/skill-creator/SKILL.md +266 -0
- package/templates/claude/skills/skill-creator/references/agent-skills-spec.md +51 -0
- package/templates/claude/skills/skill-creator/scripts/encoding_utils.py +21 -0
- package/templates/claude/skills/skill-creator/scripts/init_skill.py +304 -0
- package/templates/claude/skills/skill-creator/scripts/package_skill.py +110 -0
- package/templates/claude/skills/skill-creator/scripts/quick_validate.py +66 -0
- package/templates/claude/skills/template-skill/SKILL.md +6 -0
- package/templates/claude/skills/vitest/SKILL.md +595 -0
- package/templates/claude/skills/vitest/references/async-patterns.md +82 -0
- package/templates/claude/skills/vitest/references/mock-patterns.md +78 -0
- package/templates/claude/skills/vitest/references/monorepo-setup.md +185 -0
- package/templates/claude/skills/vitest/references/turborepo-setup.md +332 -0
- package/templates/claude/skills/web-frameworks/SKILL.md +324 -0
- package/templates/claude/skills/web-frameworks/references/nextjs-app-router.md +465 -0
- package/templates/claude/skills/web-frameworks/references/nextjs-data-fetching.md +459 -0
- package/templates/claude/skills/web-frameworks/references/nextjs-optimization.md +511 -0
- package/templates/claude/skills/web-frameworks/references/nextjs-server-components.md +495 -0
- package/templates/claude/skills/web-frameworks/references/remix-icon-integration.md +603 -0
- package/templates/claude/skills/web-frameworks/references/turborepo-caching.md +551 -0
- package/templates/claude/skills/web-frameworks/references/turborepo-pipelines.md +517 -0
- package/templates/claude/skills/web-frameworks/references/turborepo-setup.md +542 -0
- package/templates/claude/skills/web-frameworks/scripts/nextjs_init.py +547 -0
- package/templates/claude/skills/web-frameworks/scripts/turborepo_migrate.py +394 -0
- package/templates/claude/workflows/development-rules.md +40 -0
- package/templates/claude/workflows/documentation-management.md +121 -0
- package/templates/claude/workflows/orchestration-protocol.md +16 -0
- package/templates/claude/workflows/primary-workflow.md +45 -0
- package/templates/claude/workflows/registry.json +37 -0
- package/templates/common/.cct.json +41 -0
- package/templates/common/.cctkignore +22 -0
- package/templates/common/.env.example +39 -0
- package/templates/common/.mcp.json.example +16 -0
- package/templates/common/metadata.json +15 -0
- package/templates/common/settings.json +79 -0
- package/templates/common/statusline.cjs +271 -0
- package/templates/config/.repomixignore +22 -0
- package/templates/config/AGENTS.md +55 -0
- package/templates/config/CLAUDE.md +87 -0
- package/templates/plans/bug-fix-template.md +69 -0
- package/templates/plans/feature-implementation-template.md +84 -0
- package/templates/plans/refactor-template.md +82 -0
- package/templates/plans/template-usage-guide.md +58 -0
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
# Mermaid.js CLI Usage
|
|
2
|
+
|
|
3
|
+
Command-line interface for converting Mermaid diagrams to SVG/PNG/PDF.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
**Global Install:**
|
|
8
|
+
```bash
|
|
9
|
+
npm install -g @mermaid-js/mermaid-cli
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
**Local Install:**
|
|
13
|
+
```bash
|
|
14
|
+
npm install @mermaid-js/mermaid-cli
|
|
15
|
+
./node_modules/.bin/mmdc -h
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
**No Install (npx):**
|
|
19
|
+
```bash
|
|
20
|
+
npx -p @mermaid-js/mermaid-cli mmdc -h
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
**Docker:**
|
|
24
|
+
```bash
|
|
25
|
+
docker pull ghcr.io/mermaid-js/mermaid-cli/mermaid-cli
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
**Requirements:** Node.js ^18.19 || >=20.0
|
|
29
|
+
|
|
30
|
+
## Basic Commands
|
|
31
|
+
|
|
32
|
+
**Convert to SVG:**
|
|
33
|
+
```bash
|
|
34
|
+
mmdc -i input.mmd -o output.svg
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
**Convert to PNG:**
|
|
38
|
+
```bash
|
|
39
|
+
mmdc -i input.mmd -o output.png
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
**Convert to PDF:**
|
|
43
|
+
```bash
|
|
44
|
+
mmdc -i input.mmd -o output.pdf
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Output format determined by file extension.
|
|
48
|
+
|
|
49
|
+
## CLI Flags
|
|
50
|
+
|
|
51
|
+
**Core Options:**
|
|
52
|
+
- `-i, --input <file>` - Input file (use `-` for stdin)
|
|
53
|
+
- `-o, --output <file>` - Output file path
|
|
54
|
+
- `-t, --theme <name>` - Theme: default, dark, forest, neutral
|
|
55
|
+
- `-b, --background <color>` - Background: transparent, white, #hex
|
|
56
|
+
- `--cssFile <file>` - Custom CSS for styling
|
|
57
|
+
- `--configFile <file>` - Mermaid configuration file
|
|
58
|
+
- `-h, --help` - Show all options
|
|
59
|
+
|
|
60
|
+
**Example with All Options:**
|
|
61
|
+
```bash
|
|
62
|
+
mmdc -i diagram.mmd -o output.png \
|
|
63
|
+
-t dark \
|
|
64
|
+
-b transparent \
|
|
65
|
+
--cssFile custom.css \
|
|
66
|
+
--configFile mermaid-config.json
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Advanced Usage
|
|
70
|
+
|
|
71
|
+
**Stdin Piping:**
|
|
72
|
+
```bash
|
|
73
|
+
cat diagram.mmd | mmdc --input - -o output.svg
|
|
74
|
+
|
|
75
|
+
# Or inline
|
|
76
|
+
cat << EOF | mmdc --input - -o output.svg
|
|
77
|
+
graph TD
|
|
78
|
+
A[Start] --> B[End]
|
|
79
|
+
EOF
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
**Batch Processing:**
|
|
83
|
+
```bash
|
|
84
|
+
for file in *.mmd; do
|
|
85
|
+
mmdc -i "$file" -o "${file%.mmd}.svg"
|
|
86
|
+
done
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
**Markdown Files:**
|
|
90
|
+
Process markdown with embedded diagrams:
|
|
91
|
+
```bash
|
|
92
|
+
mmdc -i README.template.md -o README.md
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Docker Workflows
|
|
96
|
+
|
|
97
|
+
**Basic Docker Usage:**
|
|
98
|
+
```bash
|
|
99
|
+
docker run --rm \
|
|
100
|
+
-u $(id -u):$(id -g) \
|
|
101
|
+
-v /path/to/diagrams:/data \
|
|
102
|
+
ghcr.io/mermaid-js/mermaid-cli/mermaid-cli \
|
|
103
|
+
-i diagram.mmd -o output.svg
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
**Mount Working Directory:**
|
|
107
|
+
```bash
|
|
108
|
+
docker run --rm -v $(pwd):/data \
|
|
109
|
+
ghcr.io/mermaid-js/mermaid-cli/mermaid-cli \
|
|
110
|
+
-i /data/input.mmd -o /data/output.png
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
**Podman (with SELinux):**
|
|
114
|
+
```bash
|
|
115
|
+
podman run --userns keep-id --user ${UID} \
|
|
116
|
+
--rm -v /path/to/diagrams:/data:z \
|
|
117
|
+
ghcr.io/mermaid-js/mermaid-cli/mermaid-cli \
|
|
118
|
+
-i diagram.mmd
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Configuration Files
|
|
122
|
+
|
|
123
|
+
**Mermaid Config (JSON):**
|
|
124
|
+
```json
|
|
125
|
+
{
|
|
126
|
+
"theme": "dark",
|
|
127
|
+
"look": "handDrawn",
|
|
128
|
+
"fontFamily": "Arial",
|
|
129
|
+
"flowchart": {
|
|
130
|
+
"curve": "basis"
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
**Usage:**
|
|
136
|
+
```bash
|
|
137
|
+
mmdc -i input.mmd --configFile config.json -o output.svg
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
**Custom CSS:**
|
|
141
|
+
```css
|
|
142
|
+
.node rect {
|
|
143
|
+
fill: #f9f;
|
|
144
|
+
stroke: #333;
|
|
145
|
+
}
|
|
146
|
+
.edgeLabel {
|
|
147
|
+
background-color: white;
|
|
148
|
+
}
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
**Usage:**
|
|
152
|
+
```bash
|
|
153
|
+
mmdc -i input.mmd --cssFile styles.css -o output.svg
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## Node.js API
|
|
157
|
+
|
|
158
|
+
**Programmatic Usage:**
|
|
159
|
+
```javascript
|
|
160
|
+
import { run } from '@mermaid-js/mermaid-cli';
|
|
161
|
+
|
|
162
|
+
await run('input.mmd', 'output.svg', {
|
|
163
|
+
theme: 'dark',
|
|
164
|
+
backgroundColor: 'transparent'
|
|
165
|
+
});
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
**With Options:**
|
|
169
|
+
```javascript
|
|
170
|
+
import { run } from '@mermaid-js/mermaid-cli';
|
|
171
|
+
|
|
172
|
+
await run('diagram.mmd', 'output.png', {
|
|
173
|
+
theme: 'forest',
|
|
174
|
+
backgroundColor: '#ffffff',
|
|
175
|
+
cssFile: 'custom.css',
|
|
176
|
+
configFile: 'config.json'
|
|
177
|
+
});
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
## Common Workflows
|
|
181
|
+
|
|
182
|
+
**Documentation Generation:**
|
|
183
|
+
```bash
|
|
184
|
+
# Convert all diagrams in docs/
|
|
185
|
+
find docs/ -name "*.mmd" -exec sh -c \
|
|
186
|
+
'mmdc -i "$1" -o "${1%.mmd}.svg"' _ {} \;
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
**Styled Output:**
|
|
190
|
+
```bash
|
|
191
|
+
# Create dark-themed transparent diagrams
|
|
192
|
+
mmdc -i architecture.mmd -o arch.png \
|
|
193
|
+
-t dark \
|
|
194
|
+
-b transparent \
|
|
195
|
+
--cssFile animations.css
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
**CI/CD Pipeline:**
|
|
199
|
+
```yaml
|
|
200
|
+
# GitHub Actions example
|
|
201
|
+
- name: Generate Diagrams
|
|
202
|
+
run: |
|
|
203
|
+
npm install -g @mermaid-js/mermaid-cli
|
|
204
|
+
mmdc -i docs/diagram.mmd -o docs/diagram.svg
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
**Accessibility-Enhanced:**
|
|
208
|
+
```bash
|
|
209
|
+
# Diagrams with accTitle/accDescr preserved
|
|
210
|
+
mmdc -i accessible-diagram.mmd -o output.svg
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
## Troubleshooting
|
|
214
|
+
|
|
215
|
+
**Permission Issues (Docker):**
|
|
216
|
+
Use `-u $(id -u):$(id -g)` to match host user permissions.
|
|
217
|
+
|
|
218
|
+
**Large Diagrams:**
|
|
219
|
+
Increase Node.js memory:
|
|
220
|
+
```bash
|
|
221
|
+
NODE_OPTIONS="--max-old-space-size=4096" mmdc -i large.mmd -o out.svg
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
**Validation:**
|
|
225
|
+
Check syntax before rendering:
|
|
226
|
+
```bash
|
|
227
|
+
mmdc -i diagram.mmd -o /dev/null || echo "Invalid syntax"
|
|
228
|
+
```
|
|
@@ -0,0 +1,232 @@
|
|
|
1
|
+
# Mermaid.js Configuration & Theming
|
|
2
|
+
|
|
3
|
+
Configuration options, theming, and customization for Mermaid.js v11.
|
|
4
|
+
|
|
5
|
+
## Configuration Methods
|
|
6
|
+
|
|
7
|
+
**1. Site-wide Initialization:**
|
|
8
|
+
```javascript
|
|
9
|
+
mermaid.initialize({
|
|
10
|
+
theme: 'dark',
|
|
11
|
+
startOnLoad: true,
|
|
12
|
+
securityLevel: 'strict',
|
|
13
|
+
fontFamily: 'Arial'
|
|
14
|
+
});
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
**2. Diagram-level Frontmatter:**
|
|
18
|
+
````markdown
|
|
19
|
+
```mermaid
|
|
20
|
+
---
|
|
21
|
+
theme: forest
|
|
22
|
+
look: handDrawn
|
|
23
|
+
---
|
|
24
|
+
flowchart TD
|
|
25
|
+
A --> B
|
|
26
|
+
```
|
|
27
|
+
````
|
|
28
|
+
|
|
29
|
+
**3. Configuration Hierarchy:**
|
|
30
|
+
Default config → Site config → Diagram config (highest priority)
|
|
31
|
+
|
|
32
|
+
## Core Options
|
|
33
|
+
|
|
34
|
+
**Rendering:**
|
|
35
|
+
- `startOnLoad`: Auto-render on page load (default: true)
|
|
36
|
+
- `securityLevel`: "strict" (default), "loose", "antiscript", "sandbox"
|
|
37
|
+
- `deterministicIds`: Reproducible SVG IDs (default: false)
|
|
38
|
+
- `maxTextSize`: Max diagram text (default: 50000)
|
|
39
|
+
- `maxEdges`: Max drawable edges (default: 500)
|
|
40
|
+
|
|
41
|
+
**Visual Style:**
|
|
42
|
+
- `look`: "classic" (default), "handDrawn"
|
|
43
|
+
- `handDrawnSeed`: Numeric seed for hand-drawn consistency
|
|
44
|
+
- `darkMode`: Boolean toggle
|
|
45
|
+
|
|
46
|
+
**Typography:**
|
|
47
|
+
- `fontFamily`: "trebuchet ms, verdana, arial, sans-serif" (default)
|
|
48
|
+
- `fontSize`: Base text size (default: 16)
|
|
49
|
+
|
|
50
|
+
**Layout:**
|
|
51
|
+
- `layout`: "dagre" (default), "elk", "tidy-tree", "cose-bilkent"
|
|
52
|
+
|
|
53
|
+
**Debug:**
|
|
54
|
+
- `logLevel`: 0-5 from trace to fatal
|
|
55
|
+
- `htmlLabels`: Enable HTML in labels (default: false)
|
|
56
|
+
|
|
57
|
+
## Theming
|
|
58
|
+
|
|
59
|
+
**Built-in Themes:**
|
|
60
|
+
- `default` - Standard colors
|
|
61
|
+
- `dark` - Dark background
|
|
62
|
+
- `forest` - Green tones
|
|
63
|
+
- `neutral` - Grayscale
|
|
64
|
+
- `base` - Fully customizable
|
|
65
|
+
|
|
66
|
+
**Theme Variables (base theme only):**
|
|
67
|
+
```javascript
|
|
68
|
+
mermaid.initialize({
|
|
69
|
+
theme: 'base',
|
|
70
|
+
themeVariables: {
|
|
71
|
+
primaryColor: '#ff0000',
|
|
72
|
+
primaryTextColor: '#fff',
|
|
73
|
+
primaryBorderColor: '#7C0000',
|
|
74
|
+
secondaryColor: '#006100',
|
|
75
|
+
tertiaryColor: '#fff'
|
|
76
|
+
}
|
|
77
|
+
});
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
**Customizable Variables:**
|
|
81
|
+
- Color families: primary, secondary, tertiary
|
|
82
|
+
- Node backgrounds and text colors
|
|
83
|
+
- Border and line colors
|
|
84
|
+
- Note background/text
|
|
85
|
+
- Diagram-specific (flowchart nodes, sequence actors, pie sections)
|
|
86
|
+
|
|
87
|
+
**Custom CSS:**
|
|
88
|
+
```javascript
|
|
89
|
+
mermaid.initialize({
|
|
90
|
+
themeCSS: `
|
|
91
|
+
.node rect { fill: #f9f; }
|
|
92
|
+
.edgeLabel { background-color: white; }
|
|
93
|
+
`
|
|
94
|
+
});
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
## Accessibility
|
|
98
|
+
|
|
99
|
+
**ARIA Support:**
|
|
100
|
+
```
|
|
101
|
+
accTitle: Diagram Title
|
|
102
|
+
accDescr: Brief description
|
|
103
|
+
accDescr {
|
|
104
|
+
Multi-line detailed
|
|
105
|
+
description
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
**Auto-generated:**
|
|
110
|
+
- `aria-roledescription` attributes
|
|
111
|
+
- `<title>` and `<desc>` SVG elements
|
|
112
|
+
- `aria-labelledby` and `aria-describedby`
|
|
113
|
+
|
|
114
|
+
**WCAG Compliance:**
|
|
115
|
+
Available for all diagram types (flowchart, sequence, class, Gantt, etc.)
|
|
116
|
+
|
|
117
|
+
## Icon Configuration
|
|
118
|
+
|
|
119
|
+
**Register Icon Packs:**
|
|
120
|
+
```javascript
|
|
121
|
+
import { registerIconPacks } from 'mermaid';
|
|
122
|
+
registerIconPacks([
|
|
123
|
+
{
|
|
124
|
+
name: 'logos',
|
|
125
|
+
loader: () => import('https://esm.run/@iconify-json/logos')
|
|
126
|
+
}
|
|
127
|
+
]);
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
**Usage:**
|
|
131
|
+
```
|
|
132
|
+
architecture-beta
|
|
133
|
+
service api(logos:nodejs)[API]
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
**Loading Methods:**
|
|
137
|
+
1. CDN-based (lazy loading)
|
|
138
|
+
2. npm with dynamic import
|
|
139
|
+
3. Direct import
|
|
140
|
+
|
|
141
|
+
## Math Rendering
|
|
142
|
+
|
|
143
|
+
**KaTeX Support:**
|
|
144
|
+
```
|
|
145
|
+
graph LR
|
|
146
|
+
A["$$f(x) = x^2$$"] --> B
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
**Configuration:**
|
|
150
|
+
- `legacyMathML`: Use old MathML rendering
|
|
151
|
+
- `forceLegacyMathML`: Force legacy even if browser supports native
|
|
152
|
+
|
|
153
|
+
## Security
|
|
154
|
+
|
|
155
|
+
**Security Levels:**
|
|
156
|
+
- `strict` - HTML encoding (default, recommended)
|
|
157
|
+
- `loose` - Some HTML allowed
|
|
158
|
+
- `antiscript` - Filter scripts
|
|
159
|
+
- `sandbox` - Sandboxed mode
|
|
160
|
+
|
|
161
|
+
**DOMPurify:**
|
|
162
|
+
Enabled by default for XSS protection. Customize via `dompurifyConfig` (use caution).
|
|
163
|
+
|
|
164
|
+
## Layout Algorithms
|
|
165
|
+
|
|
166
|
+
**dagre (default):**
|
|
167
|
+
Standard hierarchical layout for most diagrams.
|
|
168
|
+
|
|
169
|
+
**elk:**
|
|
170
|
+
Advanced layout with better handling of complex graphs.
|
|
171
|
+
|
|
172
|
+
**tidy-tree:**
|
|
173
|
+
Clean tree structures for hierarchies.
|
|
174
|
+
|
|
175
|
+
**cose-bilkent:**
|
|
176
|
+
Compound graph layout for nested structures.
|
|
177
|
+
|
|
178
|
+
**Per-diagram Configuration:**
|
|
179
|
+
````markdown
|
|
180
|
+
```mermaid
|
|
181
|
+
---
|
|
182
|
+
layout: elk
|
|
183
|
+
---
|
|
184
|
+
flowchart TD
|
|
185
|
+
A --> B
|
|
186
|
+
```
|
|
187
|
+
````
|
|
188
|
+
|
|
189
|
+
## Common Patterns
|
|
190
|
+
|
|
191
|
+
**Consistent Hand-drawn Style:**
|
|
192
|
+
```javascript
|
|
193
|
+
mermaid.initialize({
|
|
194
|
+
look: 'handDrawn',
|
|
195
|
+
handDrawnSeed: 42 // Same seed = consistent appearance
|
|
196
|
+
});
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
**Dark Mode Toggle:**
|
|
200
|
+
```javascript
|
|
201
|
+
const isDark = window.matchMedia('(prefers-color-scheme: dark)').matches;
|
|
202
|
+
mermaid.initialize({
|
|
203
|
+
theme: isDark ? 'dark' : 'default'
|
|
204
|
+
});
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
**Performance Optimization:**
|
|
208
|
+
```javascript
|
|
209
|
+
mermaid.initialize({
|
|
210
|
+
startOnLoad: false, // Manual rendering
|
|
211
|
+
maxEdges: 1000, // Increase for complex graphs
|
|
212
|
+
deterministicIds: true // Caching-friendly
|
|
213
|
+
});
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
## Validation
|
|
217
|
+
|
|
218
|
+
**Parse without Rendering:**
|
|
219
|
+
```javascript
|
|
220
|
+
try {
|
|
221
|
+
await mermaid.parse('graph TD\nA-->B');
|
|
222
|
+
console.log('Valid syntax');
|
|
223
|
+
} catch(e) {
|
|
224
|
+
console.error('Invalid:', e);
|
|
225
|
+
}
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
**Programmatic Rendering:**
|
|
229
|
+
```javascript
|
|
230
|
+
const { svg } = await mermaid.render('graphId', 'graph TD\nA-->B');
|
|
231
|
+
document.getElementById('output').innerHTML = svg;
|
|
232
|
+
```
|