Skip to content

Latest commit

 

History

History
71 lines (43 loc) · 1.43 KB

README.md

File metadata and controls

71 lines (43 loc) · 1.43 KB
Raw

ScrapegraphAI Documentation

Official documentation for ScrapegraphAI - an intelligent web scraping and graph analysis tool.

ScrapegraphAI Authors

Quick Links 🔗

Development Setup

This documentation site is built with Docusaurus.

Prerequisites

  • Node.js (v14 or higher)
  • Yarn package manager

Installation

yarn

Local Development

yarn start

This starts a local development server at http://localhost:3000. The site will automatically reload if you make changes to the source files.

Building for Production

yarn build

This generates static content in the build directory, ready for deployment to any static hosting service.

Deployment

Using SSH

USE_SSH=true yarn deploy

Without SSH

GIT_USER=<Your GitHub username> yarn deploy

These commands will build the website and deploy it to the gh-pages branch. For GitHub Pages hosting, this is all you need to publish your site.

Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

License

[License details to be added]

Authors

This project is maintained by the ScrapegraphAI team. See the Authors file for more information.