Mintlify is a skill designed for creating documentation efficiently. It offers essential resources and a reference index for various tasks related to documentation building.
$ npx skills add https://github.com/codewithshreyans/skills --skill mintlifyMintlify extends AI agent capabilities with structured instructions and reference documentation for building and maintaining project documentation efficiently. The skill packages essential resources that agents can access on demand to assist with documentation tasks. It follows the Agent Skills format, making it compatible with Claude Code, Cursor, and other AI coding agents. Developers benefit from having organized documentation references readily available during code generation and editing workflows.
Install with the command: `$ npx skills add https://github.com/codewithshreyans/skills --skill mintlify`
Adding or modifying components in documentation
Changing settings in docs.json
Modifying site navigation structure for documentation
Setting up API documentation effectively
$ npx skills add https://github.com/codewithshreyans/skills --skill mintlifygit clone https://github.com/codewithshreyans/skillsCopy the install command above and run it in your terminal.
Launch Claude Code, Cursor, or your preferred AI coding agent.
Use the prompt template or examples below to test the skill.
Adapt the skill to your specific use case and workflow.
Generate high-quality documentation for [PROJECT_NAME], a [PROJECT_DESCRIPTION] in the [INDUSTRY] industry. Include sections for: installation, usage examples, API reference, troubleshooting, and contribution guidelines. Use clear headings, code blocks, and bullet points. Prioritize conciseness and readability. Base the content on [DATA_SOURCES] and ensure it aligns with [COMPANY]'s documentation standards.
# **Mintlify Documentation Generator**
## **1. Installation**
To install Mintlify for [PROJECT_NAME], run:
```bash
npm install mintlify --save-dev
```
Ensure Node.js v16+ is installed.
## **2. Quick Start**
Initialize documentation with:
```bash
mintlify init
```
This creates a `docs/` directory with templates for:
- API reference
- User guides
- Troubleshooting
## **3. API Reference**
### **Authentication**
```typescript
await mintlify.authenticate({ apiKey: "your-key" });
```
### **Code Examples**
```python
from mintlify import generate_docs
result = generate_docs(
project="my-project",
output_dir="docs"
)
```
## **4. Troubleshooting**
- **Error:** `Missing API key` → Add `MINTLIFY_API_KEY` to `.env`.
- **Error:** `Template not found` → Run `mintlify update-templates`.
## **5. Contributing**
Submit PRs to [GitHub Repo]. Follow [CONTRIBUTING.md] guidelines.
---
*Generated with Mintlify v2.4.1*
Take a free 3-minute scan and get personalized AI skill recommendations.
Take free scan