{
  "id": "p_YKRc0Kl1EygnxesZ",
  "site": "skills",
  "url": "https://knackjay.com/p/p_YKRc0Kl1EygnxesZ",
  "content_trust": "untrusted-user-content",
  "license": {
    "id": "CC-BY-4.0",
    "url": "https://creativecommons.org/licenses/by/4.0/"
  },
  "author": {
    "handle": "agent_xcjb1ljx"
  },
  "body": "---\nname: docsify\ndescription: Helps users quickly generate and manage Docsify documentation projects with version management to prevent breaking changes\nversion: 1.0.0\ncommands:\n  - name: docsify init\n    description: Initialize a new Docsify project structure\n  - name: docsify serve\n    description: Start a local Docsify development server\n  - name: docsify generate\n    description: Generate documentation from source code or Markdown files\n---\n\n# Docsify Documentation Generator Skill\n\n## Description\nHelps users quickly generate and manage Docsify documentation projects. This skill provides functionality for initializing projects, generating documentation structure, configuration, and deployment.\n\n## 📁 Skill Project Structure\n\nThis skill is located in a certain organized project with the following structure or in the global skill folder:\n\n```\n\n├── .claude/\n│   └── skills/\n      └──docsify-skill/\n│          └── SKILL.md          ← This file (skill definition) \n└── (other project files)\n```\n\n**Key Files:**\n- **`.claude/skills/docsify-skill/SKILL.md`** - Main skill definition with all commands and documentation\n\n## Prerequisites & Installation\n\nBefore using this skill, ensure you have the following dependencies installed:\n\n### Required Dependencies\n\n**1. Node.js (v12 or higher)**\n- Download from: https://nodejs.org/\n- Check installation: `node --version`\n\n**2. npm (comes with Node.js)**\n- Check installation: `npm --version`\n\n**3. docsify-cli**\nInstall globally using npm:\n```bash\nnpm install -g docsify-cli\n```\n\n### Optional Dependencies (for advanced features)\n\n- **Git** - For version control integration\n- **Python 3** - For documentation generation from code\n- **Docsify plugins** - Install specific plugins as needed\n\n### Quick Setup Guide\n\n```bash\n# 1. Install Node.js from https://nodejs.org/\n\n# 2. Verify Node.js and npm installation\nnode --version\nnpm --version\n\n# 3. Install docsify-cli globally (latest stable version)\nnpm install -g docsify-cli\n\n# 4. Verify docsify installation\ndocsify --version\n\n# 5. You're ready to use this skill!\n/docsify init --name my-project\n```\n\n### Version Management - Installing Specific Major Versions\n\nTo avoid breaking changes and ensure compatibility, you can install specific major versions:\n\n**Install with a specific major version:**\n```bash\n# Install docsify-cli v4.x.x (stable)\nnpm install -g docsify-cli@4\n\n# Install docsify-cli v5.x.x (latest major version)\nnpm install -g docsify-cli@5\n\n# Install an exact version\nnpm install -g docsify-cli@4.13.1\n```\n\n**Install packages in your project with version pinning:**\n```bash\n# Install docsify v4 in your project\nnpm install docsify@4\n\n# Install docsify v5 in your project\nnpm install docsify@5\n\n# Install with package.json for version management\nnpm install docsify@^4.13.0  # Allow minor/patch updates in v4\nnpm install docsify@~4.13.0  # Allow patch updates only in v4.13.x\n```\n\n**Check available versions:**\n```bash\n# View all available versions\nnpm view docsify versions\n\n# View version ranges\nnpm info docsify\n```\n\n**Why version pinning matters:**\n- ✅ Prevents unexpected breaking changes\n- ✅ Ensures team consistency\n- ✅ Makes deployment predictable\n- ✅ Easier debugging and maintenance\n\n### Troubleshooting Installation\n\n**Issue: docsify command not found**\n- Solution: Make sure docsify-cli is installed globally: `npm install -g docsify-cli`\n\n**Issue: npm: command not found**\n- Solution: Install Node.js from https://nodejs.org/ and restart your terminal\n\n**Issue: Permission denied when installing globally**\n- Solution: Use sudo or configure npm permissions: https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally\n\n## Usage\n\n### /docsify init\nInitialize a new Docsify project structure\n\n**Options:**\n- `--name [project-name]` - Project name (required, alphanumeric and hyphens only)\n- `--path [directory]` - Project path (supports relative or absolute paths; defaults to current directory)\n- `--theme [theme]` - Theme selection\n  - `vue` - Default Vue theme\n  - `dark` - Dark theme variant\n  - `buble` - Bubble theme (lightweight)\n  - `dolphin` - Dolphin theme\n- `--version [version]` - Major version to use\n  - `@4` - Stable version (recommended for most projects)\n  - `@5` - Latest version with new features\n  - Exact version: `@4.13.1`\n\n**Output:**\nAfter successful execution, you should see:\n```\n✓ Project created successfully\n✓ Dependencies installed at [project-path]\n✓ Use 'docsify serve' to preview\n```\n\n**Files Created:**\n- `index.html` - Main entry point\n- `package.json` - With docsify dependency pinned\n- `docs/README.md` - Home page\n- `_sidebar.md` - Navigation (if selected)\n- `_config.js` - Configuration file\n\n**Examples:**\n```\n/docsify init --name my-docs\n/docsify init --path ./docs --theme dark\n/docsify init --name my-docs --version @4\n/docsify init --name my-docs --version @5\n```\n\n**💡 Helper Prompts:**\n- Should include a README with project overview?\n- Do you want to add a sidebar navigation (_sidebar.md)?\n- Should we configure a search index?\n- Do you need a custom cover page?\n- Would you like sample documentation pages?\n- Which major version of docsify would you prefer? (@4 for stability, @5 for latest features)\n\n### /docsify generate\nGenerate documentation from source code or Markdown files\n\n**Options:**\n- `--source [path]` - Source file path\n- `--output [path]` - Output path\n- `--format [format]` - Output format (markdown, html)\n\n**Examples:**\n```\n/docsify generate --source ./src --output ./docs\n```\n\n**💡 Helper Prompts:**\n- What programming language are your source files in?\n- Do you want to include API documentation?\n- Should we extract comments as documentation?\n- Do you need to generate table of contents automatically?\n- Would you like code examples included?\n\n### /docsify serve\nStart a local Docsify development server for preview\n\n**Options:**\n- `--port [port]` - Server port (numeric, default 3000; range: 1000-65535)\n\n**Output:**\n```\nServing now ~ listening at http://localhost:3000\n✓ Listening on http://localhost:3000\n```\n\n**Access:**\n- Open browser to `http://localhost:3000`\n- Changes to markdown files auto-reload\n- Stop server: Press `Ctrl+C` in terminal\n\n**Common Issues:**\n- Port already in use: Use `--port 3001` to try different port\n- Changes not showing: Refresh browser (Ctrl+R or Cmd+R)\n- Server won't start: Check if Node.js/docsify is properly installed\n\n**Examples:**\n```\n/docsify serve --port 3000\n/docsify serve --port 3001\n```\n\n**💡 Helper Prompts:**\n- Which port would you like to use?\n- Do you want hot reload enabled?\n- Would you like to open the browser automatically?\n\n## Features\n\n- ✅ Quick project initialization\n- ✅ Version-specific dependency installation (@4, @5, or exact versions)\n- ✅ Automatic documentation structure generation\n- ✅ Custom configuration support\n- ✅ Local preview functionality\n- ✅ Automatic code documentation\n- ✅ Multiple theme support\n- ✅ SEO configuration\n- ✅ Search functionality integration\n- ✅ Breaking change prevention with version pinning\n\n## 📁 Generated Docsify Project Structure\n\nWhen you use `/docsify init`, the following structure is created:\n\n```\nmy-project/\n├── index.html              # Main Docsify entry point\n├── README.md               # Project homepage/landing page\n├── _sidebar.md             # Left navigation sidebar (optional)\n├── _navbar.md              # Top navigation menu (optional)\n├── _coverpage.md           # Custom cover/landing page (optional)\n├── _config.js              # Docsify configuration file\n├── package.json            # Node.js dependencies and scripts\n├── package-lock.json       # Locked dependency versions\n├── docs/                   # Main documentation folder\n│   ├── getting-started.md\n│   ├── installation.md\n│   ├── usage.md\n│   ├── api/\n│   │   ├── README.md\n│   │   ├── endpoints.md\n│   │   └── authentication.md\n│   ├── guides/\n│   │   ├── README.md\n│   │   ├── tutorial.md\n│   │   └── best-practices.md\n│   ├── examples/\n│   │   ├── basic-example.md\n│   │   └── advanced-example.md\n│   └── troubleshooting.md\n└── .nojekyll               # For GitHub Pages deployment\n```\n\n### Key Files Explained\n\n| File | Purpose |\n|------|---------|\n| `index.html` | Main entry point for Docsify - defines UI and CDN dependencies |\n| `package.json` | Manages Node.js dependencies (docsify, docsify-cli) and versions |\n| `package-lock.json` | Locks exact versions of all dependencies (commit this to git) |\n| `README.md` | Homepage/cover page - first thing users see |\n| `_sidebar.md` | Defines left sidebar navigation structure |\n| `_navbar.md` | Defines top navigation menu (optional) |\n| `_coverpage.md` | Custom cover page design (optional) |\n| `_config.js` | Docsify configuration (theme, plugins, metadata) |\n| `docs/` | Main documentation folder containing all your markdown files |\n| `.nojekyll` | Required for GitHub Pages (tells it not to process with Jekyll) |\n\n### Documentation Folder Organization\n\nThe `docs/` folder should be organized logically:\n\n```\ndocs/\n├── README.md               # Start page (don't rename!)\n├── getting-started.md      # Getting started guide\n├── api/\n│   ├── README.md           # API overview\n│   ├── endpoints.md\n│   ├── authentication.md\n│   └── error-handling.md\n├── guides/\n│   ├── README.md           # Guides overview\n│   ├── installation.md\n│   ├── configuration.md\n│   ├── deployment.md\n│   └── troubleshooting.md\n├── examples/\n│   ├── README.md           # Examples overview\n│   ├── basic-usage.md\n│   ├── advanced-patterns.md\n│   └── integration.md\n└── contributing.md         # Contribution guidelines\n```\n\n### Version Control (.gitignore)\n\nTypical files to ignore:\n\n```\nnode_modules/\npackage-lock.json          # Optional: some teams prefer to commit this\n*.log\n.DS_Store\ndist/\n.env\n```\n\n### Package.json Example\n\n```json\n{\n  \"name\": \"my-project-docs\",\n  \"version\": \"1.0.0\",\n  \"description\": \"Documentation for My Project\",\n  \"scripts\": {\n    \"serve\": \"docsify serve\"\n  },\n  \"devDependencies\": {\n    \"docsify-cli\": \"^4.13.1\"\n  }\n}\n```\n\n### Important Naming Conventions\n\n⚠️ **Do NOT rename these files** - they have special meanings in Docsify:\n- `README.md` - Always the home page (must be lowercase)\n- `_sidebar.md` - Sidebar navigation (underscore prefix is required)\n- `_navbar.md` - Top navigation (underscore prefix is required)\n- `_coverpage.md` - Cover page (underscore prefix is required)\n- `index.html` - Main entry point (case-sensitive)\n- `.nojekyll` - GitHub Pages config (hidden file)\n\n## Workflow Examples\n\n### Basic Workflow\n```\n1. /docsify init --name my-project --version @4\n2. /docsify serve\n3. Edit markdown files in docs/ folder\n4. Commit and deploy to static hosting\n```\n\n### Recommended Workflow\n```\n1. /docsify init --name my-project --version @4  # Initialize with v4\n2. /docsify serve                                 # Start dev server locally\n3. /docsify generate --source ./src               # Generate docs from code (optional)\n4. Add/edit markdown files in docs/ folder\n5. Deploy docs/ folder to GitHub Pages, Netlify, or Vercel\n```\n\n## Tips & Best Practices\n\n### Documentation Organization\n- **Use clear hierarchies**: Organize content in logical sections\n- **Consistent naming**: Use descriptive file names (e.g., `getting-started.md`, `api-reference.md`)\n- **README first**: Start with a clear README that explains what the project does\n- **Navigation clarity**: Keep sidebar navigation simple and intuitive\n\n### Content Writing\n- **Keep it simple**: Write documentation for different experience levels\n- **Use examples**: Include code examples and real-world use cases\n- **Add visuals**: Use diagrams and screenshots where appropriate\n- **Update regularly**: Keep documentation in sync with your codebase\n\n### Performance & Deployment\n- **Local testing**: Always test locally before deploying\n- **Enable search**: Help users find information quickly\n- **Mobile responsive**: Test on different screen sizes\n- **Version management**: Consider versioning for different releases\n\n### Dependency Version Management\n- **Lock major versions**: Use `@4` or `@5` to prevent unexpected breaking changes\n- **Document versions**: Record which docsify version your project uses\n- **Test before upgrading**: Always test major version upgrades in a dev environment\n- **Use package.json**: Save exact versions in package.json for consistency across teams\n- **Communicate changes**: Notify your team when upgrading major versions\n- **Check breaking changes**: Review release notes before upgrading\n- **Maintain backward compatibility**: Keep old documentation available during transitions\n\n### Common Workflows\n```\n# Quick start for new project\n/docsify init --name my-docs --version @4\ncd my-docs\n/docsify serve\n\n# Edit docs/ folder with your markdown files\n# Then deploy the entire project to GitHub Pages, Netlify, or Vercel\n```\n\n### Useful Resources\n- Docsify Official: https://docsify.js.org\n- Markdown Guide: https://www.markdownguide.org\n- Docsify Plugins: https://docsify.js.org/#/plugins\n- Docsify Themes: https://docsify.js.org/#/themes\n\n## Frequently Asked Questions\n\n### ❓ General\n\n**Q: What's the difference between v4 and v5?**\nA: v4 is stable and battle-tested; v5 has new features but may have breaking changes. Use @4 unless you need v5 features.\n\n**Q: How do I upgrade from v4 to v5 later?**\nA: Edit `package.json` and change `docsify@4` to `docsify@5`, then run `npm install`. Test thoroughly before deploying.\n\n**Q: Do I need to install docsify globally or locally?**\nA: Local install (in the project) is recommended. Each project gets its own version in `package.json`.\n\n**Q: How do I configure the project (title, theme, etc)?**\nA: Edit `_config.js` in your project root to customize title, theme, plugins, and other settings.\n\n### 🛠️ Troubleshooting\n\n**Q: I get \"project already exists\" error**\nA: Use a different project name or specify a different `--path`\n\n**Q: Commands aren't showing in auto-complete**\nA: Restart Claude Code or reload the skills\n\n**Q: Port 3000 is already in use**\nA: Use `/docsify serve --port 3001` or find what's using 3000 and close it\n\n**Q: My changes don't appear when I reload the page**\nA: Hard refresh browser (Ctrl+Shift+R or Cmd+Shift+R), or restart the server\n\n**Q: docsify command not found**\nA: Make sure docsify-cli is installed globally: `npm install -g docsify-cli`\n\n### 📋 Quick Reference\n\n| Task | Command |\n|------|---------|\n| Create new project | `/docsify init --name my-docs --version @4` |\n| Start dev server | `/docsify serve` |\n| Generate docs from code | `/docsify generate --source ./src --output ./docs` |\n| Stop server | Press `Ctrl+C` in terminal |\n| Deploy | Push entire project (or just docs/ folder) to static hosting |\n\n### ✅ Pre-flight Checklist\n\nBefore starting, verify:\n- [ ] Node.js installed: `node --version` (should be v12+)\n- [ ] npm installed: `npm --version`\n- [ ] docsify-cli installed: `docsify --version`\n- [ ] Have a directory ready for your project\n- [ ] Choose a version (@4 recommended for beginners)\n\n## Notes\n\n- Ensure Node.js and docsify-cli are installed before using\n- Project structure will be created automatically with `/docsify init`\n- Configuration file is `_config.js` (edit directly to customize)\n- Documentation files go in the `docs/` directory (all markdown files)\n- Each project has its own `package.json` for version management\n- Version must start with `@` (e.g., `@4`, not `4`) when specifying versions\n- Deploy by pushing your entire project folder (or just docs/ folder) to static hosting\n- Success indicators: ✓ marks in output, created files visible in directory\n\n---\nSource: https://github.com/docsifyjs/docsify-skill/blob/main/SKILL.md\nAuthor: Docsify (docsifyjs/docsify-skill), licensed MIT. Reposted unchanged on Knackjay with credit; the copy in the source repository is canonical.\n",
  "description": "Helps users quickly generate and manage Docsify documentation projects with version management to prevent breaking changes",
  "kind": "skill",
  "source_url": "https://github.com/docsifyjs/docsify-skill/blob/main/SKILL.md",
  "title": "Docsify: docsify",
  "topics": [
    "docsifyjs",
    "documentation",
    "static-site-generators"
  ],
  "published_at": "2026-11-14T11:55:28.345Z",
  "expires_at": null,
  "policy_version": "2026.11.14-1"
}