SingleFile is a Net Extension (and a CLI instrument) like minded with Chrome, Firefox (Desktop and Cell), Microsoft Edge, Vivaldi, Courageous, Waterfox, Yandex browser, and Opera. It allows you to place a total web suppose material right into a single HTML file.

Table of Contents

• Demo
• Install
• Getting started
• Extra notes
• FAQ
• Release notes
• Known points
• Troubleshooting unknown points
• Account for Line Interface
• Integration with user scripts
• SingleFileZ
• File layout comparison
• Projects the reveal of SingleFile
• Privacy policy
• Contributors
• Icons
• Code derived from third occasion projects
• License

Demo

Install

SingleFile shall be installed on:

• Firefox: https://addons.mozilla.org/firefox/addon/single-file
• Chrome: https://chrome.google.com/extensions/component/mpiodijhokgodhhofbcjdecpffjipkle
• Microsoft Edge: https://microsoftedge.microsoft.com/addons/component/efnbkdcfmcmnhlkaijjjmhjjgladedno

It’s seemingly you’ll per chance presumably moreover salvage the zip file (https://github.com/gildas-lormeau/SingleFile/archive/master.zip) of the project and install it manually by unzipping it someplace in your disk and following these instructions:

• Firefox: https://extensionworkshop.com/documentation/salvage/brief-term-set up-in-firefox/
• Chrome: https://developer.chrome.com/extensions/getstarted#manifest (omit the manifest advent)
• Microsoft Edge: https://docs.microsoft.com/en-us/microsoft-edge/extensions-chromium/getting-started/part1-easy-extension#flee-your-extension-locally-in-your-browser-while-increasing-it-side-loading

Getting started

• Wait till the online page is fully loaded.
• Click on the SingleFile button in the extension toolbar to place the online page.
• It’s seemingly you’ll per chance presumably click on once more on the button to abolish the action when processing a online page.

Extra notes

• Open the context menu by correct-clicking the SingleFile button in the extension toolbar or on the webpage. It lets in you to place:
  • the recent tab,
  • the chosen suppose material,
  • the chosen body.
• It’s seemingly you’ll per chance presumably moreover route of plenty of tabs in a single click on and place:
  • the chosen tabs,
  • the unpinned tabs,
  • the total tabs.
• Capture “Annotate and place the online page…” in the context menu to:
  • spotlight text,
  • add notes,
  • indulge in suppose material.
• The context menu moreover lets in you to urged the auto-place of:
  • the recent tab,
  • the unpinned tabs,
  • the total tabs.
• With auto-place lively, pages are routinely saved whenever after being loaded (or sooner than being unloaded if no longer).
• Factual-click on on the SingleFile button and procure “Manage extension” (Firefox) / “Choices” (Chrome) to open the options online page.
• Enable the possibility “Shuttle space> place to Google Power” or “Shuttle space> add to GitHub” to add pages to Google Power or GitHub respectively.
• Enable the possibility “Misc.> add proof of existence” to command the existence of saved pages by linking the SHA256 of the pages into the blockchain.
• It’s seemingly you’ll per chance presumably reveal the customizable shortkey Ctrl+Shift+Y to place the recent tab or the chosen tabs. Trudge to about:addons and procure “Manage extension shortcuts” in the cogwheel menu to replace it in Firefox. Trudge to chrome://extensions/shortcuts to replace it in Chrome.
• The default place folder is the salvage folder configured in your browser, cf. about:addons in Firefox and chrome://settings in Chrome.
• Perceive the extension relief in the options online page for additional detailed info in regards to the options and technical notes.

FAQ

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

Release notes

Perceive https://addons.mozilla.org/firefox/addon/single-file/variations/

Known Components

• All browsers:
  • For security causes, you may per chance well no longer place pages hosted on https://chrome.google.com, https://addons.mozilla.org and a few varied Mozilla domains. When this happens, 🛇 is displayed on prime of the SingleFile icon.
  • For security causes, SingleFile is every so in most cases unable to place the image illustration of canvas and snapshots of video aspects.
  • The final saved route can no longer be remembered by default. To bypass this limitation, disable the possibility “Misc> place pages in background”.
  • The next characters are modified with _ in file names: ~, +, , ?, %, *, : , |, ", , >
• Chromium-primarily based browsers:
  • It’s important to enable the possibility “Enable salvage admission to to file URLs” in the extension online page to existing the infobar when viewing a saved online page, and to place or to annotate a online page stored on the filesystem.
  • If the file name of a saved online page looks like “56833935-156b-4d8c-a00f-19599c6513d3.html”, disable the possibility “Misc> place pages in background”. Reinstalling the browser may per chance well per chance also fix this relate. It’s seemingly you’ll per chance presumably get extra info about this bug right here.
  • Disabling the possibility “File name> open the “Save as” dialog to ascertain the file name” will work if and supreme if the possibility “Inquire of of the set up to place each file sooner than downloading” is disabled in chrome://settings/downloads.
• Firefox:
  • The “File name> file name conflict decision” option would now not work if spot to “urged for a fame”
  • In most cases, SingleFile is unable to place the contents of sandboxed iframes due to this bug.
  • When processing a online page from the filesystem, external resources (e.g. photos, stylesheets, fonts and heaps others.) will no longer be embedded into the saved online page. It’s seemingly you’ll per chance presumably get extra info about this bug right here. This bug has been closed by Mozilla as “WontFix”. Nonetheless there’s a straightforward workaround proposed right here.
• Waterfox Traditional
  • User interface aspects displayed in the online page (growth bar, logs panel) will no longer be displayed except dom.webcomponents.enabled is enabled in about:config.
  • When opening pages saved with the possibility “Photos> group replica photos collectively” enabled, some replica photos will no longer displayed. It is advised to disable this option.

Troubleshooting unknown points

Please apply these steps when you survey an unknown relate:

• Save the online page in incognito.
• If saving online page in incognito did no longer fix the problem, reset SingleFile options.
• If resetting options did no longer fix the problem, restart the browser.
• If restarting the browser did no longer fix the problem, strive to disable all varied extensions to survey if there’s a conflict.
• If there’s a conflict then strive to envision against which extension(s).
• Please file the problem with a brief description on study the design to reproduce it right here: https://github.com/gildas-lormeau/SingleFile/points.

Account for Line Interface

It will place you web sites to HTML from the assert line interface. Perceive right here for additional info: https://github.com/gildas-lormeau/SingleFile/blob/master/cli/README.MD.

Integration with user scripts

It’s seemingly you’ll per chance presumably salvage a user script appropriate sooner than (and after) SingleFile saves a online page. For extra info, survey https://github.com/gildas-lormeau/SingleFile/wiki/How-to-salvage-a-user-script-sooner than-a-online page-is-saved.

SingleFileZ

SingleFileZ is a fork of SingleFile that lets in you to place a webpage as a self-extracting HTML file. This HTML file is moreover a sound ZIP file which contains the resources (photos, fonts, stylesheets and frames) of the saved online page. This ZIP file shall be unzipped on the filesystem in philosophize, for instance, to explore the online page in a browser that can no longer beef up pages saved with SingleFileZ.

More info right here: https://github.com/gildas-lormeau/SingleFileZ

File layout comparison

Footnotes:

¹ A swap needs to be passed from the assert line in Chromium-primarily based browsers, and an option needs to be enabled in Safari.

² Entirely in Chromium-primarily based browsers, and Data superhighway Explorer.

³ Entirely in Safari.

⁴ An option needs to be enabled in the extension.

Projects the reveal of SingleFile

• ArchiveBox – Open-source self-hosted web archiving: https://github.com/ArchiveBox/ArchiveBox
• htmls-to-datasette – Instrument to index HTML recordsdata right into a Sqlite database: https://github.com/pjamar/htmls-to-datasette
• singlefile2trilium – Instrument to place devoted reproduction of an online suppose material as a Trilium existing with SingleFile: https://github.com/nil0x42/singlefile2trilium
• SingleFileMacOS – Integration of SingleFile in a swift application the reveal of webkit: https://github.com/captaindavepdx/SingleFileMacOS
• Zotero Connector – Browser extension for Zotero, a instrument to enable you bag, address, cite, and allotment your analysis sources: https://github.com/zotero/zotero-connectors

Privacy Coverage

Perceive https://github.com/gildas-lormeau/SingleFile/blob/master/privateness.md

Contributors

• Chinese translation achieved 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)
• Frail Chinese translation achieved by frostblazergit (https://github.com/frostblazergit), lqzhgood (https://github.com/lqzhgood)
• German translation achieved by womotroll (https://github.com/womotroll), bannmann (https://github.com/bannmann)
• Italian translation achieved by Fastbyte01 (https://github.com/Fastbyte01)
• Eastern translation achieved by Shitennouji（四天王寺) (https://github.com/Shitennouji)
• Polish translation achieved by xesarni (https://github.com/xesarni)
• Russian translation achieved by rstp14 (https://github.com/rstp14), kramola-RU (https://github.com/kramola-RU), solokot (https://github.com/solokot), TotalCaesar659 (https://github.com/TotalCaesar659)
• Ukrainian translation achieved by perdolka (https://github.com/perdolka)
• Spanish translation achieved by strel (https://github.com/strel)

Code derived from third occasion projects

• csstree: https://github.com/csstree/csstree
• postcss-media-request-parser: https://github.com/dryoma/postcss-media-request-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

Icons

• Icon made by Kiranshastry from Flaticon is licensed by CC 3.0 BY

License

SingleFile is licensed below AGPL. Code derived from third-occasion projects is licensed below MIT. Please contact me at gildas.lormeau gmail.com when you may per chance well per chance be inquisitive about licensing the SingleFile code for a commercial service or product.

Ideas are welcome 🙂