The InkLoom agent skill is a provider-agnostic skill file that teaches any coding agent how to work with InkLoom. One install gives your agent instant InkLoom expertise — it can create projects, write beautiful documentation, and deploy to production without you touching the dashboard or CLI.
What Your Agent Can Do
Scaffold new InkLoom projects with the right structure, navigation, and settings — ready to publish.
Author rich documentation pages using all 24 InkLoom components — callouts, tabs, code blocks, cards, and more.
Push docs from your local directory and deploy to production via the InkLoom CLI, all in a single workflow.
Configure GitHub Actions or other CI/CD systems to auto-deploy your documentation on every push.
Walk your users through InkLoom account creation, API key setup, and project onboarding.
Installation
Point your coding agent at the InkLoom skill URL:
``javascript https://inkloom.io/skill `
Most agents accept a skill URL directly. Consult your agent's documentation for the exact install command.
Once installed, your agent has full knowledge of InkLoom's CLI, MDX components, platform features, and deployment workflows. Just describe what you want in plain language.
Example Prompts
Here are some realistic prompts you can give your coding agent after installing the skill:
`plaintext
Create an InkLoom project for my API and push the docs from ./docs
`
`plaintext
Write a getting-started guide for our SDK with installation steps and code examples
`
`plaintext
Set up GitHub Actions to auto-deploy our docs when we push to main
`
`plaintext
Add API reference pages for our REST endpoints using the OpenAPI spec
``
What's Included
The skill file bundles everything your agent needs to work with InkLoom:
- Core instructions — how InkLoom projects are structured, how pages and folders work
- CLI reference — every command, flag, and option for the InkLoom CLI
- MDX component reference — usage and props for all 24 components (callouts, tabs, code blocks, cards, steps, and more)
- Platform guide — authentication, project settings, themes, custom domains, and publishing
- CI/CD templates — ready-to-use GitHub Actions workflows and deployment configurations
- Starter templates — pre-built project structures for common documentation patterns
Links
Get started with the InkLoom CLI for local documentation workflows.
Full reference for writing MDX with InkLoom's component library.
Automate documentation deploys in your CI/CD pipeline.