Welcome to the Firecrawl documentation repository! This repo contains the source files for docs.firecrawl.dev, powered by Mintlify.
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.
To get started with the Firecrawl documentation, follow the steps below:
- Node.js (version 19 or higher)
-
Install Mintlify globally using npm:
npm install -g mintlify
Or if you prefer yarn:
yarn global add mintlify
-
Clone this repository and navigate to the directory:
git clone https://github.com/hellofirecrawl/docs.git cd docs -
Start the Mintlify development server:
mintlify dev
-
Open your web browser and visit http://localhost:3000 to see a local preview of the documentation.
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.
If you have any questions or need further assistance, please reach out to us at [email protected].
Happy crawling with Firecrawl! 🔥🕷️