Getting Started
This guide walks you through the Skrypt hosted platform. By the end, you will have a live documentation site at your-project.skrypthq.dev.
Prerequisites
- An email address for account creation
- Source material for your docs: a GitHub repo, local markdown files, or an existing Mintlify site
1. Create an account
Go to app.skrypt.sh and sign up with your email and password. You will receive a confirmation email. Click the link to verify your account.
The free tier includes 1 project, 1 AI generation per month, and 3 deploys per day. No credit card required.
2. Create a project
After signing in, the onboarding wizard walks you through project setup in three steps.
First, enter a project name. Skrypt auto-generates a URL slug from your name. For example, entering "My API" produces the slug my-api and the docs URL:
https://my-api.skrypthq.dev
The slug must be unique and can only contain lowercase letters, numbers, and hyphens.
Click Continue to proceed.
3. Choose a source
The wizard presents three import methods:
| Method | Best for |
|---|---|
| GitHub | Generating docs from source code with AI |
| Upload | Importing existing markdown or MDX files |
| Mintlify | Migrating an existing Mintlify docs site |
Select a method and follow the prompts. See Importing Content for detailed instructions on each method.
You can also click Skip for now and add a source later from the dashboard.
4. Your docs site is live
After completing the source step, Skrypt deploys your documentation. The wizard confirms success and redirects you to the dashboard.
Your docs are immediately available at:
https://{your-slug}.skrypthq.dev
5. Dashboard overview
The dashboard is your control center. After onboarding, you land on the project list view.
Project card
Each project card shows:
- Project name and slug
- Docs URL (
{slug}.skrypthq.dev) - Last deploy timestamp
- Source type (GitHub, upload, or Mintlify import)
Project actions
From a project, you can:
- Generate -- run AI doc generation from connected source code
- Deploy -- push the latest content to your live site
- Settings -- update project name, manage sources, or delete the project
Account settings
Access account settings from the top-right menu to manage your email, password, and subscription tier.
Free vs Pro
| Free | Pro ($199/mo) | |
|---|---|---|
| Projects | 1 | 10 |
| AI generations | 1/month | Unlimited |
| Deploys | 3/day | Unlimited |
| Sources | All three methods | All three methods |
Upgrade to Pro by contacting the Skrypt team. Pro is billed via manual invoice.
What's next
- Importing Content, connect GitHub, upload files, or migrate from Mintlify
- Quickstart, use the Skrypt CLI for local generation and testing
- Configuration, customize source paths, output format, and LLM settings
- Deploy Guide, deploy to Skrypt hosting or your own infrastructure