https://github.com/mendableai/firecrawl-docs
Documentation for Firecrawl.
https://github.com/mendableai/firecrawl-docs
docs firecrawl firecrawl-ai firecrawl-mcp
Last synced: 4 months ago
JSON representation
Documentation for Firecrawl.
- Host: GitHub
- URL: https://github.com/mendableai/firecrawl-docs
- Owner: mendableai
- Created: 2025-04-29T14:08:16.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-06-12T13:36:23.000Z (4 months ago)
- Last Synced: 2025-06-12T14:43:48.826Z (4 months ago)
- Topics: docs, firecrawl, firecrawl-ai, firecrawl-mcp
- Language: MDX
- Homepage: https://docs.firecrawl.dev
- Size: 5.12 MB
- Stars: 4
- Watchers: 3
- Forks: 8
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: contributing/guide.mdx
Awesome Lists containing this project
README
# Firecrawl Docs 🔥
Welcome to the Firecrawl documentation repository! This repo contains the source files for [docs.firecrawl.dev](https://docs.firecrawl.dev), powered by [Mintlify](https://mintlify.com/).
## About Firecrawl
Firecrawl is an open-source tool that turns websites into LLM-ready data. With Firecrawl, you can power your AI applications with clean data crawled from any website, making it easier to create powerful and accurate language models.
## Getting Started
To get started with the Firecrawl documentation, follow the steps below:
### Prerequisites
- Node.js (version 19 or higher)
### Installation
1. Install Mintlify globally using npm:
```bash
npm install -g mintlify
```
Or if you prefer yarn:
```bash
yarn global add mintlify
```
2. Clone this repository and navigate to the directory:
```bash
git clone https://github.com/mendableai/firecrawl-docs.git
cd docs
```
3. Start the Mintlify development server:
```bash
mintlify dev
```
4. Open your web browser and visit [http://localhost:3000](http://localhost:3000) to see a local preview of the documentation.
## Contributing
We welcome contributions to improve the Firecrawl documentation! If you find any issues or want to suggest enhancements, please open an issue or submit a pull request to this repository.
When contributing, please follow these guidelines:
- Keep the documentation clear, concise, and easy to understand.
- Use proper formatting and adhere to the existing document structure.
- Test your changes locally before submitting a pull request.
## Contact
If you have any questions or need further assistance, please reach out to us at [hello@firecrawl.dev](mailto:hello@firecrawl.dev).
Happy crawling with Firecrawl! 🔥🕷️