Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .mintlify/skills
23 changes: 23 additions & 0 deletions ai/skillmd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
better results using your product with their AI tools.
</Tip>

## `skill.md` structure

Check warning on line 49 in ai/skillmd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/skillmd.mdx#L49

'structure' should use sentence-style capitalization.

Mintlify generates a `skill.md` file following the [agentskills.io specification](https://agentskills.io/specification). The generated file includes:

Expand Down Expand Up @@ -84,6 +84,29 @@
You can use both approaches together with a root `skill.md` file and `.mintlify/skills/` directory. The discovery index includes all skills.
</Note>

### Use symlinks to avoid duplication

If your skill files live elsewhere in your repository (for example, in a `plugins/` or `skills/` directory), you can symlink `.mintlify/skills` to that location instead of duplicating files:

```bash
# Skills live in a top-level skills/ directory
ln -s ../skills .mintlify/skills
```

```
project/
skills/
payments/
SKILL.md
analytics/
SKILL.md
.mintlify/
skills -> ../skills
docs.json
```

Mintlify resolves symlinks during deployment, so the skill files are discovered and served as if they were directly inside `.mintlify/skills/`. This works with both directory symlinks and individual skill symlinks.

Check warning on line 108 in ai/skillmd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/skillmd.mdx#L108

In general, use active voice instead of passive voice ('are discovered').

### Frontmatter fields

Custom `skill.md` files must start with YAML frontmatter.
Expand Down
File renamed without changes.
File renamed without changes.
Loading