Exports and Reports
SiteOne Crawler offers export and reporting features, enabling users to generate and share reports with colleagues or clients.
Report formats
Section titled โReport formatsโ- Audit HTML report: The primary, interactive, and structured HTML audit report with visual elements for easy analysis and sharing. This report is also reasonably readable on mobile devices and in mobile email clients.
- JSON: Structured data exports suitable for automated processing and integration with other tools. See
--output-json-file. - TXT: Plain text exports for quick review and sharing. The output is the same as the console output. See
--output-text-file.
Reports can also be sent automatically using the integrated Mailer through your SMTP server.
All reports now include the Website Quality Score - an automatic 0.0โ10.0 score across five weighted categories (Performance, SEO, Security, Accessibility, Best Practices) - so you get an at-a-glance assessment alongside the detailed findings.
Export features
Section titled โExport featuresโ- Offline Website Generator: Export a complete copy of the website for offline viewing or archiving. Named also as a website downloader, website copier, website cloner or website ripper.
- Website to Markdown Converter: Export the entire website (or a single local HTML file) to clean, browsable Markdown - ideal for AI tools, documentation and archival.
- Sitemap Generator: Generate a
sitemap.xmlandsitemap.txtfile for search engines to index your website.
Standalone HTML-to-Markdown conversion
Section titled โStandalone HTML-to-Markdown conversionโYou donโt need to crawl a whole website to get Markdown. You can convert a single local HTML file to clean Markdown using the same conversion pipeline as the full export:
# Print Markdown to stdout (pipe-friendly)./siteone-crawler --html-to-markdown=page.html
# Write Markdown to a file./siteone-crawler --html-to-markdown=page.html --html-to-markdown-output=page.mdNo crawling is performed. See --html-to-markdown and --html-to-markdown-output, and the Website to Markdown Converter page for details.
Built-in HTTP server for browsing exports
Section titled โBuilt-in HTTP server for browsing exportsโAfter exporting, you can browse your Markdown or offline HTML exports locally with the built-in HTTP server - no separate web server needed and no crawling performed:
# Browse a markdown export (rendered as styled HTML)./siteone-crawler --serve-markdown=./tmp/mydomain.tld.md
# Browse an offline HTML export./siteone-crawler --serve-offline=./tmp/mydomain.tld| Parameter | Description | Default |
|---|---|---|
--serve-markdown | Start an HTTP server to browse a Markdown export directory. Renders .md files as styled HTML with table and accordion support. | |
--serve-offline | Start an HTTP server to browse an offline HTML export directory. Serves files with a Content-Security-Policy restricting to the same origin. | |
--serve-port | Port for the built-in HTTP server. | 8321 |
--serve-bind-address | Bind address for the built-in HTTP server. Use 0.0.0.0 to listen on all network interfaces. | 127.0.0.1 |
๐ก What would you improve?
Section titled โ๐ก What would you improve?โIf you have ideas on how to improve the export or report features, donโt be afraid to send a feature request (to desktop application, or to command-line interface) with a suggestion for improvement. We are happy to consider and implement it if it will benefit more users.