SingleFile README

The project's README from github.com/gildas-lormeau/SingleFile. As one markdown file: README.md.

SingleFile

SingleFile helps you to save a complete web page into a single HTML file. SingleFile is a Web Extension (and a CLI tool) compatible with Chrome, Firefox (Desktop and Mobile), Microsoft Edge, Safari, Vivaldi, Brave, Waterfox, Yandex browser, and Opera.

Table of Contents

Demo

https://user-images.githubusercontent.com/396787/156664907-cc458e35-f41b-45ca-91eb-372213812b44.mp4

Install

SingleFile can be installed from the store of:

You can also download the zip file (https://github.com/gildas-lormeau/SingleFile/archive/master.zip) of the project and install it manually by unzipping it somewhere on your disk and following these instructions:

Getting started

Additional notes

FAQ

See https://github.com/gildas-lormeau/SingleFile/blob/master/faq.md

Release notes

See https://addons.mozilla.org/firefox/addon/single-file/versions/

Known Issues and Troubleshooting

See https://github.com/gildas-lormeau/SingleFile/blob/master/known-issues.md

Command Line Interface (SingleFile CLI)

You can save web pages to HTML from the command line interface. See here for more info: https://github.com/gildas-lormeau/single-file-cli.

Integration with user scripts

You can execute a user script just before (and after) SingleFile saves a page. For more info, see https://github.com/gildas-lormeau/SingleFile/wiki/How-to-execute-a-user-script-before-a-page-is-saved.

File format comparison

| | HTML | Self-extracting ZIP | MHTML | Webarchive (Safari) | HTML+folder | | --- | :---: | :---: | :---: | :---: | :---: | | Pages are saved as a single file | ✓ | ✓ | ✓ | ✓ | | | HTML and styles are minified | ✓ | ✓ | | | | | Unused HTML and styles are removed from files | ✓ | ✓ | | | | | Binary resources are not encoded in base 64 | | ✓ | | ✓ | ✓ | | Files are compressed | | ✓ | | | | | Files can be viewed without installing any extension | ✓ | ✓¹ | ✓² | ✓³ | ✓ | | Files can be viewed without running JavaScript | ✓ | | ✓ | ✓ | ✓ | | Files can be unzipped to extract page resources | | ✓ | | | n/a | | Files contains the text of the page (plain or formatted) which can be indexed | ✓ | ✓⁴ | ✓ | ✓ | ✓ |

Footnotes:

¹ When using the "universal" self-extracting file format

² Only in Chromium-based browsers, and Internet Explorer

³ Only in Safari

⁴ An option must be enabled in the extension

Projects using/compatible with SingleFile

Privacy Policy

See https://github.com/gildas-lormeau/SingleFile/blob/master/privacy.md

Contributors

See https://github.com/gildas-lormeau/SingleFile/blob/master/contributors.md

Code derived from third party projects

Icons

License

SingleFile is licensed under AGPL. Code derived from third-party projects is licensed under MIT. Please contact me at gildas.lormeau <at> gmail.com if you are interested in licensing the SingleFile code for a commercial service or product.

Suggestions are welcome :)

SingleFile (gildas-lormeau/SingleFile)

archive
Searching Database…

What is this?SingleFile is a browser extension that saves a complete, faithful copy of any web page into a single HTML file you can keep and reopen later.
Is it a browser extension or a desktop app?It is a web extension that lives in your browser toolbar, not a desktop program. There is also a separate command-line tool, SingleFile CLI, for saving pages from the terminal.
How do I install it and save my first page?Install from your browser's store (Firefox, Firefox for Android, Chrome, Safari, Edge) or manually from the zip release. Then click the SingleFile button in the toolbar to save the page, or use the Ctrl+Shift+Y shortcut.
Can someone open my saved page without installing SingleFile?Yes — the default single HTML file opens in any browser without the extension and without JavaScript. MHTML files only open in Chromium browsers and Internet Explorer, Safari webarchives only in Safari, and self-extracting ZIP files need JavaScript unless they use the universal format.
Which browsers can I use it with?Chrome, Firefox (desktop and mobile), Microsoft Edge, Safari (macOS and iOS), Vivaldi, Brave, Waterfox, Yandex browser and Opera.
Where do saved pages end up — my computer or a server?They stay local by default: pages are saved to the download folder configured in your browser. Optionally, you can enable saving to Google Drive or uploading to GitHub in the options.
Is it free to use, even commercially?It is free and open source under AGPL, with derived third-party code under MIT. To use the SingleFile code in a commercial service or product, the author asks you to contact him about licensing.
Can I highlight text or add notes to a page before saving it?Yes. Choose 'Annotate and save the page...' in the context menu to highlight text, add notes, or remove content before the page is saved.
Can it save pages automatically as I browse?Yes. Auto-save can be enabled for the current tab, unpinned tabs, or all tabs, and each page is then saved automatically after it loads. You can also batch-save selected, unpinned, or all tabs in one click.
What is the proof-of-existence option?An option that links the SHA-256 hash of a saved page into the blockchain, so the existence of the page in exactly that form can later be proven.
Do other tools build on SingleFile?Yes — ArchiveBox for web archiving, bookmark managers like linkding, Linkwarden and Karakeep, the KOReader e-book reader, the Zotero Connector, and an Obsidian plugin for reading saved pages all work with SingleFile files.
Size
347.4 MB
Stars
22.6K
Age
16y
Commits · 90 Days