The official documentation for Screenshothis - a modern screenshot API for developers. Generate beautiful, high-quality screenshots of any website with a single HTTP request.
- 📖 Live Documentation: docs.screenshothis.com
- 🎮 API Playground: screenshothis.com/playground
- 🔑 Get API Keys: screenshothis.com/keys
- 💻 GitHub Repository: github.com/screenshothis/screenshothis
This documentation covers everything you need to use Screenshothis effectively:
- Getting Started: Quick setup and your first screenshot in under 2 minutes
- API Reference: Complete parameter documentation with examples
- JavaScript SDK: Official TypeScript SDK with full type safety
- Self-hosting: Run Screenshothis on your own infrastructure
- Health Monitoring: Kubernetes-compatible health checks
You need Node.js and the Mintlify CLI installed:
npm install -g mintlify- Clone this repository:
git clone https://github.com/screenshothis/docs.git
cd screenshothis-docs- Start the development server:
mintlify dev- Open localhost:3000 to view the documentation.
- Edit any
.mdxfile to update content - Changes auto-reload in your browser
- Check the terminal for any syntax errors
screenshothis-docs/
├── index.mdx # Landing page
├── quickstart.mdx # Quick start guide
├── api-reference/ # API documentation
│ ├── introduction.mdx # API overview
│ ├── screenshots/ # Screenshot endpoints
│ └── health/ # Health check endpoints
├── sdk/ # SDK documentation
│ └── js.mdx # JavaScript/TypeScript SDK
└── self-host/ # Self-hosting guides
├── index.mdx # Self-hosting overview
├── configuration.mdx # Configuration options
├── deployment.mdx # Deployment guides
└── troubleshooting.mdx # Common issues
We follow industry-leading technical writing practices:
- User-centered: Focus on what users want to accomplish
- Clear language: Use direct, active voice in second person ("you")
- Progressive disclosure: Basic concepts before advanced topics
- Actionable content: Every section should help users achieve a goal
- Consistent terminology: Same terms mean the same things throughout
Use these components for better user experience:
<Tip>
Expert advice and pro tips that enhance user success
</Tip>
<Warning>
Critical information about potential issues or breaking changes
</Warning>
<Check>
Positive confirmations and successful completion indicators
</Check>
<Steps>
<Step title="First step">
Content for the first step
</Step>
</Steps>We welcome contributions to improve the documentation:
- Fork this repository
- Create a feature branch:
git checkout -b improve-quickstart - Make your changes following our writing guidelines
- Test locally with
mintlify dev - Submit a pull request with a clear description
- Fix typos and grammar issues
- Improve explanations of complex concepts
- Add examples for common use cases
- Update outdated information
- Enhance accessibility and readability
Documentation automatically deploys when changes are pushed to the main branch. The GitHub App integration handles:
- Automatic builds from the repository
- Production deployment within minutes
- Preview deployments for pull requests
Mintlify dev won't start
mintlify install # Reinstalls dependenciesPage shows 404 error
- Ensure you're in the directory with
docs.json - Check that the file path matches the navigation structure
Changes not appearing
- Check the terminal for syntax errors
- Verify the file is saved
- Try refreshing your browser
This documentation is open source under the AGPL-3.0 License.
Need help?
- 📧 Email: support@screenshothis.com
- 💬 GitHub Issues: Create an issue
- 🌐 Website: screenshothis.com