create-docs — for Claude Code create-docs, docs.basicmemory.com, community, for Claude Code, ide skills, pnpm-lock.yaml, pnpm install, pnpm run, pnpm add, package-lock.json

v1.0.0

このスキルについて

適した場面: Ideal for AI agents that need generate a complete, production-ready documentation site for any project. ローカライズされた概要: # Create Docs Generate a complete, production-ready documentation site for any project. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

機能

Generate a complete, production-ready documentation site for any project.
Analyze - Detect package manager, monorepo structure, read context
Initialize - Create docs directory with correct setup
Generate - Write documentation pages using templates
Configure - Set up AI integration (MCP, llms.txt)

# 主なトピック

basicmachines-co basicmachines-co
[7]
[3]
更新日: 4/6/2026

Skill Overview

Start with fit, limitations, and setup before diving into the repository.

適した場面: Ideal for AI agents that need generate a complete, production-ready documentation site for any project. ローカライズされた概要: # Create Docs Generate a complete, production-ready documentation site for any project. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

このスキルを使用する理由

推奨ポイント: create-docs helps agents generate a complete, production-ready documentation site for any project. Create Docs Generate a complete, production-ready documentation site for any project. This AI agent skill

おすすめ

適した場面: Ideal for AI agents that need generate a complete, production-ready documentation site for any project.

実現可能なユースケース for create-docs

ユースケース: Applying Generate a complete, production-ready documentation site for any project
ユースケース: Applying Analyze - Detect package manager, monorepo structure, read context
ユースケース: Applying Initialize - Create docs directory with correct setup

! セキュリティと制限

  • 制約事項: ├── docs/ → Existing docs (avoid overwriting)
  • 制約事項: Check if project needs multi-language docs:
  • 制約事項: Requires repository-specific context from the skill documentation

About The Source

The section below comes from the upstream repository. Use it as supporting material alongside the fit, use-case, and installation summary on this page.

Labs デモ

Browser Sandbox Environment

⚡️ Ready to unleash?

Experience this Agent in a zero-setup browser environment powered by WebContainers. No installation required.

Boot Container Sandbox

FAQ とインストール手順

These questions and steps mirror the structured data on this page for better search understanding.

? よくある質問

create-docs とは何ですか?

適した場面: Ideal for AI agents that need generate a complete, production-ready documentation site for any project. ローカライズされた概要: # Create Docs Generate a complete, production-ready documentation site for any project. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

create-docs はどうやって導入しますか?

次のコマンドを実行してください: npx killer-skills add basicmachines-co/docs.basicmemory.com/create-docs。Cursor、Windsurf、VS Code、Claude Code など19以上のIDEで使えます。

create-docs の主な用途は?

主な用途は次のとおりです: ユースケース: Applying Generate a complete, production-ready documentation site for any project, ユースケース: Applying Analyze - Detect package manager, monorepo structure, read context, ユースケース: Applying Initialize - Create docs directory with correct setup。

create-docs に対応するIDEは?

このスキルは Cursor, Windsurf, VS Code, Trae, Claude Code, OpenClaw, Aider, Codex, OpenCode, Goose, Cline, Roo Code, Kiro, Augment Code, Continue, GitHub Copilot, Sourcegraph Cody, and Amazon Q Developer に対応しています。統一された導入には Killer-Skills CLI を使えます。

create-docs に制限はありますか?

制約事項: ├── docs/ → Existing docs (avoid overwriting). 制約事項: Check if project needs multi-language docs:. 制約事項: Requires repository-specific context from the skill documentation.

このスキルの導入方法

  1. 1. ターミナルを開く

    プロジェクトディレクトリでターミナルまたはコマンドラインを開きます。

  2. 2. インストールコマンドを実行

    npx killer-skills add basicmachines-co/docs.basicmemory.com/create-docs を実行してください。CLI がIDEまたはエージェントを自動検出し、スキルを設定します。

  3. 3. スキルを使い始める

    このスキルはすぐに有効になります。現在のプロジェクトで create-docs をすぐ使えます。

! Source Notes

This page is still useful for installation and source reference. Before using it, compare the fit, limitations, and upstream repository notes above.

Upstream Repository Material

The section below comes from the upstream repository. Use it as supporting material alongside the fit, use-case, and installation summary on this page.

Upstream Source

create-docs

# Create Docs Generate a complete, production-ready documentation site for any project. This AI agent skill supports Claude Code, Cursor, and Windsurf

SKILL.md
Readonly
Upstream Repository Material
The section below comes from the upstream repository. Use it as supporting material alongside the fit, use-case, and installation summary on this page.
Upstream Source

Create Docs

Generate a complete, production-ready documentation site for any project.

Workflow

  1. Analyze - Detect package manager, monorepo structure, read context
  2. Initialize - Create docs directory with correct setup
  3. Generate - Write documentation pages using templates
  4. Configure - Set up AI integration (MCP, llms.txt)
  5. Finalize - Provide next steps with correct commands

Package Manager Reference

Detect from lock files, default to npm if none found:

Lock FilePMInstallRunAdd
pnpm-lock.yamlpnpmpnpm installpnpm runpnpm add
package-lock.jsonnpmnpm installnpm runnpm install
yarn.lockyarnyarn installyarnyarn add
bun.lockbbunbun installbun runbun add

Use [pm] as placeholder in commands below.


Step 1: Analyze Project

Detect Project Structure

Check for:
├── pnpm-workspace.yaml   → pnpm monorepo
├── turbo.json            → Turborepo monorepo
├── lerna.json            → Lerna monorepo
├── nx.json               → Nx monorepo
├── apps/                 → Apps directory (monorepo)
├── packages/             → Packages directory (monorepo)
├── docs/                 → Existing docs (avoid overwriting)
├── README.md             → Main documentation source
└── src/ or lib/          → Source code location

Determine Docs Location

Project TypeTarget DirectoryWorkspace Entry
Standard project./docsN/A
Monorepo with apps/./apps/docsapps/docs
Monorepo with packages/./docsdocs
Existing docs/ folderAsk user or ./documentation

Read Context Files

FileExtract
README.mdProject name, description, features, usage examples
package.jsonName, description, dependencies, repository URL
src/ or lib/Exported functions, composables for API docs

Detect i18n Requirement

Check if project needs multi-language docs:

IndicatorAction
@nuxtjs/i18n in dependenciesUse i18n template
locales/ or i18n/ folder existsUse i18n template
Multiple language README filesUse i18n template
User explicitly mentions multiple languagesUse i18n template
None of the aboveUse default template

Step 2: Initialize Docs

Create Directory Structure

Default template:

[docs-location]/
├── app/                            # Optional: for customization
│   ├── app.config.ts
│   ├── components/
│   ├── layouts/
│   └── pages/
├── content/
│   ├── index.md
│   └── 1.getting-started/
│       ├── .navigation.yml
│       └── 1.introduction.md
├── public/
│   └── favicon.ico
├── package.json
└── .gitignore

i18n template (if multi-language detected):

[docs-location]/
├── app/
│   └── app.config.ts
├── content/
│   ├── en/
│   │   ├── index.md
│   │   └── 1.getting-started/
│   │       ├── .navigation.yml
│   │       └── 1.introduction.md
│   └── fr/                         # Or other detected languages
│       ├── index.md
│       └── 1.getting-started/
│           ├── .navigation.yml
│           └── 1.introduction.md
├── nuxt.config.ts                  # Required for i18n config
├── public/
│   └── favicon.ico
├── package.json
└── .gitignore

Create package.json

Default:

json
1{ 2 "name": "[project-name]-docs", 3 "private": true, 4 "scripts": { 5 "dev": "nuxt dev --extends docus", 6 "build": "nuxt build --extends docus", 7 "generate": "nuxt generate --extends docus", 8 "preview": "nuxt preview --extends docus" 9 }, 10 "dependencies": { 11 "docus": "latest", 12 "better-sqlite3": "^12.5.0", 13 "nuxt": "^4.2.2" 14 } 15}

i18n (add @nuxtjs/i18n):

json
1{ 2 "name": "[project-name]-docs", 3 "private": true, 4 "scripts": { 5 "dev": "nuxt dev --extends docus", 6 "build": "nuxt build --extends docus", 7 "generate": "nuxt generate --extends docus", 8 "preview": "nuxt preview --extends docus" 9 }, 10 "dependencies": { 11 "@nuxtjs/i18n": "^10.2.1", 12 "docus": "latest", 13 "better-sqlite3": "^12.5.0", 14 "nuxt": "^4.2.2" 15 } 16}

Create nuxt.config.ts (i18n only)

ts
1export default defineNuxtConfig({ 2 modules: ['@nuxtjs/i18n'], 3 i18n: { 4 locales: [ 5 { code: 'en', language: 'en-US', name: 'English' }, 6 { code: 'fr', language: 'fr-FR', name: 'Français' } 7 ], 8 defaultLocale: 'en' 9 } 10})

Create .gitignore

node_modules
.nuxt
.output
.data
dist

Update Monorepo Configuration (if applicable)

pnpm Monorepo

  1. Add docs to workspace and configure onlyBuiltDependencies (required for better-sqlite3):
yaml
1packages: 2 - 'apps/*' 3 - 'docs' 4 5onlyBuiltDependencies: 6 - better-sqlite3
  1. Add dev script to root package.json:
json
1{ 2 "scripts": { 3 "docs:dev": "pnpm run --filter [docs-package-name] dev" 4 } 5}

Or with directory path:

json
1{ 2 "scripts": { 3 "docs:dev": "cd docs && pnpm dev" 4 } 5}

npm/yarn Monorepo

json
1{ 2 "workspaces": ["apps/*", "docs"], 3 "scripts": { 4 "docs:dev": "npm run dev --workspace=docs" 5 } 6}

Step 3: Generate Documentation

Use templates from references/templates.md.

CRITICAL: MDC Component Naming

All Nuxt UI components in MDC must use the u- prefix:

CorrectWrong
::u-page-hero::page-hero
::u-page-section::page-section
:::u-page-feature:::page-feature
:::u-button:::button
::::u-page-card::::page-card

Without the u- prefix, Vue will fail to resolve the components.

Documentation Structure

content/
├── index.md                        # Landing page
├── 1.getting-started/
│   ├── .navigation.yml
│   ├── 1.introduction.md
│   └── 2.installation.md
├── 2.guide/
│   ├── .navigation.yml
│   ├── 1.configuration.md
│   ├── 2.authentication.md
│   └── 3.deployment.md
└── 3.api/                          # If applicable
    ├── .navigation.yml
    └── 1.reference.md

Generate Pages

  1. Landing page (index.md) - Hero + features grid
  2. Introduction - What & why, use cases
  3. Installation - Prerequisites, install commands
  4. Guide pages - Feature documentation with action-based H2 headings

For writing style, see references/writing-guide.md. For MDC components, see references/mdc-components.md.


Step 4: Configure AI Integration

Docus automatically includes MCP server (/mcp) and llms.txt generation. No configuration needed.

Do NOT add AI Integration sections to the landing page. These features work automatically.

Optionally mention in the introduction page:

markdown
1::note 2This documentation includes AI integration with MCP server and automatic `llms.txt` generation. 3::

Optional: app.config.ts

ts
1export default defineAppConfig({ 2 docus: { 3 name: '[Project Name]', 4 description: '[Project description]', 5 url: 'https://[docs-url]', 6 socials: { 7 github: '[org]/[repo]' 8 } 9 } 10})

Optional: Theme Customization

If the project has a design system or brand colors, customize the docs theme.

Custom CSS

Create app/assets/css/main.css:

css
1@import "tailwindcss"; 2@import "@nuxt/ui"; 3 4@theme static { 5 /* Custom font */ 6 --font-sans: 'Inter', sans-serif; 7 8 /* Custom container width */ 9 --ui-container: 90rem; 10 11 /* Custom primary color (use project brand color) */ 12 --color-primary-50: oklch(0.97 0.02 250); 13 --color-primary-500: oklch(0.55 0.2 250); 14 --color-primary-900: oklch(0.25 0.1 250); 15}

Extended app.config.ts

ts
1export default defineAppConfig({ 2 docus: { 3 name: '[Project Name]', 4 description: '[Project description]', 5 url: 'https://[docs-url]', 6 socials: { 7 github: '[org]/[repo]', 8 x: '@[handle]' 9 } 10 }, 11 // Customize UI components 12 ui: { 13 colors: { 14 primary: 'emerald', 15 neutral: 'zinc', 16 }, 17 pageHero: { 18 slots: { 19 title: 'font-semibold sm:text-6xl' 20 } 21 } 22 } 23})

Step 5: Finalize

Provide instructions using detected package manager.

Standard Project

Documentation created in [docs-location]

To start:

  cd [docs-location]
  [pm] install
  [pm] run dev

Available at http://localhost:3000

Monorepo

Documentation created in [docs-location]

To start from root:

  [pm] install
  [pm] run docs:dev

Or from docs directory:

  cd [docs-location]
  [pm] run dev

Available at http://localhost:3000

Features Included

  • Full-text search
  • Dark mode
  • MCP server for AI tools (/mcp)
  • LLM integration (/llms.txt)
  • SEO optimized

Next Steps

  1. Review generated content
  2. Add more guides in content/2.guide/
  3. Customize theme in app.config.ts
  4. Deploy to Vercel/Netlify/Cloudflare

Suggest Follow-ups

After documentation is created, suggest enhancements:

Your documentation is ready!

Would you like me to:
- **Customize the UI** - Match your brand colors and style
- **Enhance the landing page** - Add feature cards, code previews, visuals
- **Add i18n support** - Multi-language documentation
- **Set up deployment** - Deploy to Vercel, Netlify, or Cloudflare

Let me know what you'd like to improve!

Deployment

PlatformCommandOutput
Vercelnpx vercel --prodAuto-detected
Netlify[pm] run generate.output/public
Cloudflare Pages[pm] run generate.output/public
GitHub Pages[pm] run generate.output/public

Example: auth-utils

Detected: pnpm monorepo, package in packages/

Generated structure:

docs/
├── content/
│   ├── index.md
│   ├── 1.getting-started/
│   │   ├── .navigation.yml
│   │   ├── 1.introduction.md
│   │   └── 2.installation.md
│   ├── 2.guide/
│   │   ├── .navigation.yml
│   │   ├── 1.authentication.md
│   │   ├── 2.oauth-providers.md
│   │   └── 3.sessions.md
│   └── 3.api/
│       ├── .navigation.yml
│       └── 1.composables.md
├── public/
│   └── favicon.ico
├── package.json
└── .gitignore

Inside authentication.md (action-based H2 headings):

markdown
1## Add basic authentication 2## Protect your routes 3## Handle login redirects 4## Customize the session

関連スキル

Looking for an alternative to create-docs or another community skill for your workflow? Explore these related open-source skills.

すべて表示

openclaw-release-maintainer

Logo of openclaw
openclaw

ローカライズされた概要: 🦞 # OpenClaw Release Maintainer Use this skill for release and publish-time workflow. It covers ai, assistant, crustacean workflows. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

333.8k
0
AI

widget-generator

Logo of f
f

ローカライズされた概要: Generate customizable widget plugins for the prompts.chat feed system # Widget Generator Skill This skill guides creation of widget plugins for prompts.chat . It covers ai, artificial-intelligence, awesome-list workflows. This AI agent skill supports Claude Code, Cursor, and Windsurf

149.6k
0
AI

flags

Logo of vercel
vercel

ローカライズされた概要: The React Framework # Feature Flags Use this skill when adding or changing framework feature flags in Next.js internals. It covers blog, browser, compiler workflows. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

138.4k
0
ブラウザ

pr-review

Logo of pytorch
pytorch

ローカライズされた概要: Usage Modes No Argument If the user invokes /pr-review with no arguments, do not perform a review . It covers autograd, deep-learning, gpu workflows. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

98.6k
0
開発者