Saved searches
Use saved searches to filter your results more quickly
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.
Web Extension and CLI tool for saving a faithful copy of an entire web page in a single HTML file
License
gildas-lormeau/SingleFile
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Sign In Required
Please sign in to use Codespaces.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching GitHub Desktop
If nothing happens, download GitHub Desktop and try again.
Launching Xcode
If nothing happens, download Xcode and try again.
Launching Visual Studio Code
Your codespace will open once ready.
There was a problem preparing your codespace, please try again.
Latest commit
Git stats
Files
Failed to load latest commit information.
README.MD
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. It helps you to save a complete web page into a single HTML file.
- Demo
- Install
- Getting started
- Additional notes
- FAQ
- Release notes
- Known issues
- Troubleshooting unknown issues
- Command Line Interface (SingleFile CLI)
- Integration with user scripts
- SingleFileZ
- File format comparison
- Projects using/compatible with SingleFile
- Privacy policy
- Contributors
- Icons
- Code derived from third party projects
- License
SingleFile can be installed on:
- Firefox: https://addons.mozilla.org/firefox/addon/single-file
- Chrome: https://chrome.google.com/extensions/detail/mpiodijhokgodhhofbcjdecpffjipkle
- Safari: https://apps.apple.com/us/app/singlefile-for-safari/id6444322545
- Microsoft Edge: https://microsoftedge.microsoft.com/addons/detail/efnbkdcfmcmnhlkaijjjmhjjgladedno
- Firefox for Android Nightly by following this procedure: https://blog.mozilla.org/addons/2020/09/29/expanded-extension-support-in-firefox-for-android-nightly/
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:
- Click on the SingleFile button in the extension toolbar to save the page.
- You can click again on the button to cancel the action when processing a page.
- Open the context menu by right-clicking the SingleFile button in the extension toolbar or on the webpage. It allows you to save:
- the current tab,
- the selected content,
- the selected frame.
- the selected tabs,
- the unpinned tabs,
- all the tabs.
- highlight text,
- add notes,
- remove content.
- the current tab,
- the unpinned tabs,
- all the tabs.
- All browsers:
- For security reasons, you cannot save pages hosted on https://chrome.google.com, https://addons.mozilla.org and some other Mozilla domains. When this happens, 🛇 is displayed on top of the SingleFile icon.
- For security reasons, SingleFile is sometimes unable to save the image representation of canvas and snapshots of video elements.
- The last saved path cannot be remembered by default. To circumvent this limitation, disable the option «Misc > save pages in background».
- The following characters are replaced with _ in file names: ~ , + , \ , ? , % , * , : , | , » ,
- You must enable the option «Allow access to file URLs» in the extension page to display the infobar when viewing a saved page, and to save or to annotate a page stored on the filesystem.
- If the file name of a saved page looks like «56833935-156b-4d8c-a00f-19599c6513d3.html», disable the option «Misc > save pages in background». Reinstalling the browser may also fix this issue. You can find more info about this bug here.
- Disabling the option «File name > open the «Save as» dialog to confirm the file name» will work if and only if the option «Ask where to save each file before downloading» is disabled in chrome://settings/downloads.
- The «File name > file name conflict resolution» option does not work if set to «prompt for a name»
- Sometimes, SingleFile is unable to save the contents of sandboxed iframes because of this bug.
- When processing a page from the filesystem, external resources (e.g. images, stylesheets, fonts etc.) will not be embedded into the saved page. You can find more info about this bug here. This bug has been closed by Mozilla as «WontFix». But there is a simple workaround proposed here.
- User interface elements displayed in the page (progress bar, logs panel) won’t be displayed unless dom.webcomponents.enabled is enabled in about:config .
- When opening pages saved with the option «Images > group duplicate images together» enabled, some duplicate images might not displayed. It is recommended to disable this option.
Troubleshooting unknown issues
Please follow these steps if you find an unknown issue:
- Save the page in incognito.
- If saving page in incognito did not fix the issue, reset SingleFile options.
- If resetting options did not fix the issue, restart the browser.
- If restarting the browser did not fix the issue, try to disable all other extensions to see if there is a conflict.
- If there is a conflict then try to determine against which extension(s).
- Please report the issue with a short description on how to reproduce it here: https://github.com/gildas-lormeau/SingleFile/issues.
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
SingleFileZ is a fork of SingleFile that allows you to save a webpage as a self-extracting HTML file. This HTML file is also a valid ZIP file which contains the resources (images, fonts, stylesheets and frames) of the saved page. This ZIP file can be unzipped on the filesystem in order, for example, to view the page in a browser that would not support pages saved with SingleFileZ.
HTML (SingleFile) HTML (SingleFileZ) MAFF 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 resources and view pages ✓ ✓ n/a Files contains the text of the page (plain or formatted) which can be indexed ✓ ✓⁴ ✓ ✓ ✓ ¹ A switch must be passed from the command line in Chromium-based browsers, and an option must be enabled in Safari.
² Only in Chromium-based browsers, and Internet Explorer.
⁴ An option must be enabled in the extension.
Projects using/compatible with SingleFile
- ArchiveBox — Open-source self-hosted web archiving: https://github.com/ArchiveBox/ArchiveBox
- htmls-to-datasette — Tool to index HTML files into a Sqlite database: https://github.com/pjamar/htmls-to-datasette
- obsidian-html-plugin — Plugin for reading HTML pages in Obsidian: https://github.com/nuthrash/obsidian-html-plugin
- Petal Cite Web Importer — Browser extension to save PDFs and capture web pages in Petal Cite: https://github.com/ks-collab/cite-extension
- singlefile2trilium — Tool to save faithful copy of a web page as a Trilium note with SingleFile: https://github.com/nil0x42/singlefile2trilium
- SingleFileMacOS — Integration of SingleFile in a swift application using webkit: https://github.com/captaindavepdx/SingleFileMacOS
- Zotero Connector — Browser extension for Zotero, a tool to help you collect, organize, cite, and share your research sources: https://github.com/zotero/zotero-connectors
- Chinese translation done by yfdyh000 (https://github.com/yfdyh000), KrasnayaPloshchad (https://github.com/KrasnayaPloshchad), frostblazergit (https://github.com/frostblazergit), dnknn (https://github.com/dnknn), lqzhgood (https://github.com/lqzhgood)
- Traditional Chinese translation done by frostblazergit (https://github.com/frostblazergit), lqzhgood (https://github.com/lqzhgood)
- German translation done by womotroll (https://github.com/womotroll), bannmann (https://github.com/bannmann)
- Italian translation done by Fastbyte01 (https://github.com/Fastbyte01)
- Japanese translation done by Shitennouji（四天王寺) (https://github.com/Shitennouji)
- Polish translation done by xesarni (https://github.com/xesarni)
- Portuguese-Brazilian translation done by @mezysinc
- Russian translation done by rstp14, kramola-RU (https://github.com/kramola-RU), solokot (https://github.com/solokot), TotalCaesar659 (https://github.com/TotalCaesar659)
- Spanish translation done by strel (https://github.com/strel)
- Turkish translation done by hbaklan943 (https://github.com/hbaklan943)
- Ukrainian translation done by perdolka (https://github.com/perdolka), gildas-lormeau
Code derived from third party projects
- csstree: https://github.com/csstree/csstree
- postcss-media-query-parser: https://github.com/dryoma/postcss-media-query-parser
- postcss-selector-parser: https://github.com/postcss/postcss-selector-parser
- UglifyCSS: https://github.com/fmarcia/UglifyCSS
- parse-srcset: https://github.com/albell/parse-srcset
- parse-css-font: https://github.com/jedmao/parse-css-font
- Readability: https://github.com/mozilla/readability
- whatwg-mimetype: https://github.com/jsdom/whatwg-mimetype
SingleFile is licensed under AGPL. Code derived from third-party projects is licensed under MIT. Please contact me at gildas.lormeau gmail.com if you are interested in licensing the SingleFile code for a commercial service or product.
About
Web Extension and CLI tool for saving a faithful copy of an entire web page in a single HTML file