Importing Content
Skrypt supports three ways to add content to a project: GitHub connect, file upload, and Mintlify migration. You can choose any method during onboarding or add sources later from the dashboard.
GitHub connect
Connect a GitHub repository to generate documentation from your source code using AI (Claude Sonnet 4).
How it works
- Click GitHub in the source picker.
- Click Connect GitHub. This opens a GitHub OAuth flow in a new tab.
- Authorize Skrypt to access your repositories.
- After authorization, you are redirected back to the wizard.
Skrypt reads your repository code and generates structured documentation with descriptions, parameter tables, and code examples. The generated docs are deployed automatically to {slug}.skrypthq.dev.
Notes
- Skrypt requests read-only access to your repositories.
- Private repos are supported once you authorize GitHub access.
- You can skip GitHub and upload files instead by clicking Skip, I will upload files instead.
File upload
Upload markdown files directly. No GitHub account required.
Supported formats
| Format | Description |
|---|---|
.md | Standard Markdown |
.mdx | MDX (Markdown with JSX components) |
.txt | Plain text |
.zip | ZIP archive containing any of the above |
Size limits
- Maximum total size: 10 MB across all files
- No limit on the number of individual files (within the total size cap)
How it works
- Click Upload files in the source picker.
- Drag and drop files onto the upload zone, or click to browse.
- Review the file list. Remove any files by clicking the X button.
- Click Upload files to submit.
The upload zone shows a running total of file count and size. Files that do not match the accepted formats are rejected with an error message.
After upload, Skrypt processes your files and deploys the docs site.
Mintlify migration
Import an existing Mintlify docs site by pointing Skrypt at the GitHub repo where your Mintlify docs live.
How it works
- Click Mintlify in the source picker.
- Enter the GitHub repository URL (e.g.,
https://github.com/org/docs). - Set the branch (defaults to
main). - Optionally set a docs path if your Mintlify files are in a subdirectory (e.g.,
docs/). - Click Import docs.
What gets imported
Skrypt fetches:
- mint.json -- your navigation structure, site name, and configuration
- All MDX/MD files referenced in the navigation
- Directory structure preserved from your repo layout
If mint.json defines navigation groups, Skrypt builds an index page with links organized by group. If no mint.json is found, Skrypt scans the directory tree (up to 3 levels deep) for all .mdx and .md files.
Limits
- Maximum of 200 files per import
- Files in
_snippets/directories and dotfile directories are skipped - Private repos require a connected GitHub account with access
Supported Mintlify components
Mintlify MDX files are imported as-is. The Skrypt template supports these Mintlify components natively:
| Component | Description |
|---|---|
Card | Linked content card with title and description |
CardGroup | Grid layout wrapper for Card components |
Note | Informational callout box |
Warning | Warning callout box |
Info | Info callout box |
Tip | Tip callout box |
Accordion | Collapsible content section |
AccordionGroup | Wrapper for multiple Accordion components |
Tab | Single tab panel |
Tabs | Tabbed content container |
CodeGroup | Tabbed code block container |
ParamField | API parameter documentation field |
ResponseField | API response field documentation |
Expandable | Expandable detail section |
Steps | Numbered step-by-step instructions |
Step | Individual step within Steps |
Frame | Image frame with optional caption |
Snippet | Reusable content snippet |
Components not in this list render as plain HTML or are silently ignored. Custom React components from your Mintlify site will need manual migration.
After import
Once the import completes, Skrypt deploys the imported content to your docs URL. The confirmation screen shows the number of files imported and a link to your live site.
You can re-run the import at any time to pull updated content from the same repo.
What's next
- Getting Started, platform setup and dashboard overview
- Generate Guide, advanced AI generation options and multi-repo support
- Import Guide, CLI-based import from Mintlify, Docusaurus, GitBook, and more
- Testing Guide, verify code examples against your real compiler