This is the official documentation site for FileLens, a high-performance file preview generation service that provides multi-page document processing with download URL responses. The site is built using Tailwind CSS and Next.js.
To get started with this documentation site, first install the dependencies using Bun (preferred) or npm:
bun installNext, run the development server:
bun devFinally, open http://localhost:3000 in your browser to view the documentation site.
FileLens is a powerful file preview generation service that supports over 450 file formats and provides:
- Multi-page document processing: Generate previews for complex documents with multiple pages
- High-performance processing: Fast and reliable file conversion
- Download URL responses: Get direct links to generated preview files
- Wide format support: Support for documents, images, videos, and more
- API-first design: RESTful API for easy integration
🚀 Get Early Access to FileLens
FileLens is currently available through GitHub Sponsors with early access pricing:
$25 one-time payment
- Early access to FileLens, a high-performance file preview generation service written in Go
- Designed to replace the Node.js filepreview library with better performance, reliability, and cloud-native capabilities
- Access to the complete source code and deployment resources
- Priority support during the early access period
🎯 Become a Sponsor for Early Access
You can edit the documentation by modifying the MDX files in the /src/app folder. The site will auto-update as you edit these files. Each page is structured as an MDX file that combines Markdown content with React components.
This template includes a global search that's powered by the FlexSearch library. It's available by clicking the search input or by using the ⌘K shortcut.
This feature requires no configuration, and works out of the box by automatically scanning your documentation pages to build its index. You can adjust the search parameters by editing the /src/mdx/search.mjs file.
The documentation is organized into the following sections:
- API Reference: Complete API documentation and endpoints
- Quick Start: Getting started guide for new users
- Examples: Code examples and use cases
- SDKs: Language-specific SDKs and libraries
- Implementation: Integration guides and best practices
- Webhooks: Event handling and webhook configuration
- Multi-page: Advanced multi-page processing features
- Docker: Containerized deployment options
This documentation site is based on the Tailwind UI Protocol template and is licensed under the Tailwind UI license.
To learn more about the technologies used in this documentation site, see the following resources:
- FileLens Service: Visit the main FileLens documentation for API details
- Tailwind CSS - the official Tailwind CSS documentation
- Next.js - the official Next.js documentation
- MDX - the official MDX documentation for writing documentation
- FlexSearch - the search functionality powering the site
- Headless UI - accessible UI components
- Framer Motion - animation library