Skip to content

πŸ•·οΈ Official Scrapegraph API Documentation πŸ€–

License

Notifications You must be signed in to change notification settings

ScrapeGraphAI/docs-mintlify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

24 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“š ScrapeGraphAPI Documentation

ScrapeGraphAPI Logo

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.

πŸš€ Quick Start

Prerequisites

Install the Mintlify CLI to preview the documentation locally:

npm i -g mintlify

Local Development

  1. Clone this repository
  2. Navigate to the documentation directory
  3. Run the development server:
mintlify dev

The documentation will be available at http://localhost:3000.

πŸ“š Documentation Structure

.
β”œβ”€β”€ 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

🀝 Contributing

We welcome contributions to improve our documentation! Here's how you can help:

  1. Fork this repository
  2. Create a new branch for your changes
  3. Make your changes to the documentation
  4. Test locally using mintlify dev
  5. Submit a pull request

Contribution Guidelines

  • 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

πŸ› οΈ Development Tools

  • Mintlify: Documentation framework
  • MDX: Extended Markdown syntax
  • React: For interactive components
  • Node.js: Required for local development

πŸ“ License

This documentation is licensed under the MIT License - see the LICENSE file for details.

πŸ”— Useful Links

πŸ’‘ Need Help?

⭐ Show Your Support

If you find our documentation helpful, please consider giving us a star on GitHub!

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages