monolith/README.md
Sunshine 1b1befd7b0
Merge pull request #222 from snshn/readme-no-metadata-info
Add description of -M option to README.md
2020-12-09 21:29:33 -05:00

3.8 KiB
Raw Blame History

Monolith Build Status for GNU/Linux Monolith Build Status for macOS Monolith Build Status for Windows

 _____     ______________    __________      ___________________    ___
|     \   /              \  |          |    |                   |  |   |
|      \_/       __       \_|    __    |    |    ___     ___    |__|   |
|               |  |            |  |   |    |   |   |   |   |          |
|   |\     /|   |__|    _       |__|   |____|   |   |   |   |    __    |
|   | \___/ |          | \                      |   |   |   |   |  |   |
|___|       |__________|  \_____________________|   |___|   |___|  |___|

A data hoarders dream come true: bundle any web page into a single HTML file. You can finally replace that gazillion of open tabs with a gazillion of .html files stored somewhere on your precious little drive.

Unlike the conventional “Save page as”, monolith not only saves the target document, it embeds CSS, image, and JavaScript assets all at once, producing a single HTML5 document that is a joy to store and share.

If compared to saving websites with wget -mpk, this tool embeds all assets as data URLs and therefore lets browsers render the saved page exactly the way it was on the Internet, even when no network connection is available.


Installation

Via Homebrew (on macOS and GNU/Linux)

$ brew install monolith

Using Snapcraft (on GNU/Linux)

$ snap install monolith

Using Ports collection (on FreeBSD and TrueOS)

$ cd /usr/ports/www/monolith/
$ make install clean

Using pre-built binaries (Windows, ARM-based devices, etc)

Every release contains pre-built binaries for Windows, GNU/Linux, as well as platforms with non-standart CPU architecture.

From source

Dependency: libssl-dev

$ git clone https://github.com/Y2Z/monolith.git
$ cd monolith
$ make install

Using Containers

The guide can be found here


Usage

$ monolith https://lyrics.github.io/db/P/Portishead/Dummy/Roads/ -o portishead-roads-lyrics.html

Options

  • -c: Exclude CSS
  • -e: Ignore network errors
  • -f: Omit frames
  • -F: Exclude web fonts
  • -i: Remove images
  • -I: Isolate the document
  • -j: Exclude JavaScript
  • -k: Accept invalid X.509 (TLS) certificates
  • -M: Don't add timestamp and URL information
  • -o: Write output to file
  • -s: Be quiet
  • -t: Adjust network request timeout
  • -u: Provide custom User-Agent

HTTPS and HTTP proxies

Please set https_proxy, http_proxy, and no_proxy environment variables.


Contributing

Please open an issue if something is wrong, that helps make this project better.



License

The Unlicense


Keep in mind that monolith is not aware of your browsers session