docs: ecosystem + cleanup

This commit is contained in:
Karishma Shukla
2025-12-13 17:59:55 +05:30
committed by GitHub
parent d6e8caa6a1
commit 33bfbb6881

View File

@@ -30,11 +30,17 @@ Maxun is the easiest way to extract web data with no code. The <b>modern</b> ope
Maxun helps you transform websites into structured APIs, clean markdown for AI workflows, and production-ready data pipelines — all in minutes.
Choose your approach
1. [No-code UI](https://docs.maxun.dev/category/extract) Visual interface with Recorder Mode and AI Mode.
2. [SDK](https://github.com/getmaxun/node-sdk) Programmatic control for developers.
### Ecosystem
Whether you prefer clicking through a website or integrating automation into your codebase, Maxun adapts to your workflow.
1. **[Extract](https://docs.maxun.dev/category/extract)** Emulate real user behavior and collect structured data from any website. No code required.
* **[Recorder Mode](https://docs.maxun.dev/robot/extract/robot-actions)** - Record your actions as you browse; Maxun turns them into a reusable extraction robot.
* **[AI Mode](https://docs.maxun.dev/robot/extract/llm-extraction)** - Describe what you want in natural language and let LLM-powered extraction do the rest.
2. **[Scrape](https://docs.maxun.dev/robot/scrape/scrape-robots)** Convert full webpages into clean Markdown or HTML and capture screenshots. Ideal for AI workflows, agents, and document processing. No code required.
3. **[SDK](https://docs.maxun.dev/sdk/sdk-overview)** A complete developer toolkit for scraping, extraction, scheduling, and end-to-end data automation.
Whether you prefer browsing through a website or integrating automation into your codebase, Maxun adapts to your workflow.
## How Does It Work?
@@ -45,7 +51,7 @@ Maxun uses web robots to power everything you can do on the platform. There are
**Extract robots emulate real user behavior and capture structured data.**
Choose how to build them
### a. Recorder Mode: Point-and-click interface to record your actions
### a. Recorder Mode: Record your actions as you browse
- Build robots visually by browsing like a human.
- Perfect for structured, deterministic data extraction.
@@ -98,25 +104,6 @@ Maxun can run locally with or without Docker
2. [Upgrade Maxun With Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-docker-compose)
3. [Upgrade Maxun Without Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-local-setup)
## What Can Robots Do?
-**Open webpages** and navigate sites automatically
-**Log in** to secured websites and maintain sessions
-**Click on buttons**, links, and interactive elements
-**Fill out forms** with custom data
-**Select from dropdowns**, radios, checkboxes, dates, times, etc.
-**Take screenshots** - fullpage or visible sections
-**Capture structured data** without writing code
-**Handle infinite scrolling** and pagination automatically
-**Run on schedules** - set it and forget it
-**Trigger via APIs** for third-party integrations
-**Extract behind login** walls and authentication
-**Integrate with applications** like N8N, Google Sheets, Airtable, and more
-**Send data to webhooks** for real-time processing
-**Get clean HTML** from websites for AI applications
-**Turn websites into LLM-ready markdown** for AI pipelines
-**Talk to your LLM** with MCP (Model Context Protocol)
## Sponsors
<table>
@@ -135,47 +122,37 @@ Maxun can run locally with or without Docker
## Features
-**Extract Data With No-Code** - Point and click interface
-**Two Robot Types** - Extract for structured data, Scrape for clean content
-**Handle Pagination & Scrolling** - Automatic navigation
-**Run Robots On Schedules** - Set it and forget it
-**Turn Websites to APIs** - RESTful endpoints from any site
-**Turn Websites to Spreadsheets** - Direct data export
-**Adapt To Website Layout Changes** - Auto-recovery from site updates
-**Extract Behind Login** - Handle authentication seamlessly
-**Integrations** - Connect with your favorite tools
-**MCP Support** - Model Context Protocol integration
-**LLM-Ready Data** - Clean Markdown for AI applications
-**Self-Hostable** - Full control over your infrastructure
-**Open Source** - Transparent and community-driven
-**Extract Data With No-Code** Point and click interface
-**LLM-Powered Extraction** Describe what you want; use LLMs to scrape structured data
-**Developer SDK** Programmatic extraction, scheduling, and robot management
-**Handle Pagination & Scrolling** Automatic navigation
-**Run Robots On Schedules** Set it and forget it
-**Turn Websites to APIs** RESTful endpoints from any site
-**Turn Websites to Spreadsheets** Direct data export to Google Sheets & Airtable
-**Adapt To Website Layout Changes** Auto-recovery from site updates
-**Extract Behind Login** Handle authentication seamlessly
-**Integrations** Connect with your favorite tools
-**MCP Support** Model Context Protocol integration
-**LLM-Ready Data** Clean Markdown for AI applications
-**Self-Hostable** Full control over your infrastructure
-**Open Source** Transparent and community-driven
### Use Cases
## Use Cases
Maxun can be used for various use-cases, including lead generation, market research, content aggregation and more.
View use-cases in detail here: https://www.maxun.dev/#usecases
### Screenshots
![Maxun PH Launch (1)-1-1](https://github.com/user-attachments/assets/d7c75fa2-2bbc-47bb-a5f6-0ee6c162f391)
![Maxun PH Launch (1)-2-1](https://github.com/user-attachments/assets/d85a3ec7-8ce8-4daa-89aa-52d9617e227a)
![Maxun PH Launch (1)-3-1](https://github.com/user-attachments/assets/4bd5a0b4-485d-44f4-a487-edd9afc18b11)
![Maxun PH Launch (1)-4-1](https://github.com/user-attachments/assets/78140675-a6b6-49b2-981f-6a3d9a32b0b9)
![Maxun PH Launch (1)-5-1](https://github.com/user-attachments/assets/d9fe8519-c81c-4e45-92f2-b2939bf24192)
![Maxun PH Launch (1)-6-1](https://github.com/user-attachments/assets/c26e9ae3-c3da-4280-826a-c7cdf913fb93)
![Maxun PH Launch (1)-7-1](https://github.com/user-attachments/assets/fd7196f4-a6dc-4c4c-9c76-fdd93fac8247)
![Maxun PH Launch (1)-8-1](https://github.com/user-attachments/assets/16ee4a71-772a-49ae-a0e5-cb0529519bda)
![Maxun PH Launch (1)-9-1](https://github.com/user-attachments/assets/160f46fa-0357-4c1b-ba50-b4fe64453bb7)
### Note
## Note
This project is in early stages of development. Your feedback is very important for us - we're actively working on improvements. </a>
### License
## License
<p>
This project is licensed under <a href="./LICENSE">AGPLv3</a>.
</p>
### Support Us
## Support Us
Star the repository, contribute if you love what were building, or [sponsor us](https://github.com/sponsors/amhsirak).
### Contributors
## Contributors
Thank you to the combined efforts of everyone who contributes!
<a href="https://github.com/getmaxun/maxun/graphs/contributors">