Documentation | Website | Discord
This repository contains the official documentation for ScrapeGraphAPI, a suite of AI-powered web scraping tools. Our documentation is built using Mintlify, providing a modern and interactive documentation experience.
Install the Mintlify CLI to preview the documentation locally:
npm i -g mintlify
- Clone this repository
- Navigate to the documentation directory
- Run the development server:
mintlify dev
The documentation will be available at http://localhost:3000
.
.
βββ introduction.mdx # Main introduction page
βββ services/ # Core services documentation
β βββ smartscraper.mdx # SmartScraper service
β βββ localscraper.mdx # LocalScraper service
β βββ markdownify.mdx # Markdownify service
β βββ extensions/ # Browser extensions
β βββ firefox.mdx # Firefox extension
βββ sdks/ # SDK documentation
β βββ python.mdx # Python SDK
β βββ javascript.mdx # JavaScript SDK
βββ api-reference/ # API reference documentation
We welcome contributions to improve our documentation! Here's how you can help:
- Fork this repository
- Create a new branch for your changes
- Make your changes to the documentation
- Test locally using
mintlify dev
- Submit a pull request
- Follow the existing documentation structure
- Use Markdown and MDX for content
- Include clear commit messages
- Test all changes locally before submitting
- Update the navigation in
mint.json
if adding new pages
- Mintlify: Documentation framework
- MDX: Extended Markdown syntax
- React: For interactive components
- Node.js: Required for local development
This documentation is licensed under the MIT License - see the LICENSE file for details.
- Join our Discord community
- Email us at [email protected]
- Check our status page
If you find our documentation helpful, please consider giving us a star on GitHub!