monolith/README.md

[![Travis CI Build Status](https://travis-ci.org/Y2Z/monolith.svg?branch=master)](https://travis-ci.org/Y2Z/monolith)
[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/ae7soyjih8jg2bv7/branch/master?svg=true)](https://ci.appveyor.com/project/snshn/monolith/branch/master)

```
 ___     ___________    __________      ___________________    ___
|   \   /           \  |          |    |                   |  |   |
|    \_/     __      \_|    __    |    |    ___     ___    |__|   |
|           |  |           |  |   |    |   |   |   |   |          |
|           |__|    _      |__|   |____|   |   |   |   |    __    |
|   |\_/|          | \                     |   |   |   |   |  |   |
|___|   |__________|  \____________________|   |___|   |___|  |___|
```

A data hoarder's 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

### From source
    $ git clone https://github.com/Y2Z/monolith.git
    $ cd monolith
    $ cargo install --path .

### With Homebrew (on macOS and GNU/Linux)
    $ brew install monolith

### Using Snapcraft (on GNU/Linux)
    $ snap install monolith

## Usage
    $ monolith https://lyrics.github.io/db/p/portishead/dummy/roads/ -o portishead-roads-lyrics.html

## Options
 - `-c`: Ignore styles
 - `-f`: Exclude iframes
 - `-i`: Remove images
 - `-I`: Isolate document
 - `-j`: Exclude JavaScript
 - `-k`: Accept invalid X.509 (TLS) certificates
 - `-o`: Write output to file
 - `-s`: Silent mode
 - `-u`: Specify custom User-Agent

## Related projects
 - `Pagesaver`: https://github.com/distributed-mind/pagesaver
 - `SingleFile`: https://github.com/gildas-lormeau/SingleFile

## License
The Unlicense

<!-- Microtext -->
<sub>Keep in mind that `monolith` is not aware of your browser's session</sub>
Update README.md 2019-08-25 08:06:48 +02:00			`[![Travis CI Build Status](https://travis-ci.org/Y2Z/monolith.svg?branch=master)](https://travis-ci.org/Y2Z/monolith)`
Add CSP isolation, no CSS, and no iframe options 2019-09-22 02:06:00 +02:00			`[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/ae7soyjih8jg2bv7/branch/master?svg=true)](https://ci.appveyor.com/project/snshn/monolith/branch/master)`

Update README.md 2019-10-08 05:46:08 +02:00			```
			`___ ___________ __________ ___________________ ___`
			`\| \ / \ \| \| \| \| \| \|`
			`\| \_/ __ \_\| __ \| \| ___ ___ \|__\| \|`
			`\| \| \| \| \| \| \| \| \| \| \| \|`
			`\| \|__\| _ \|__\| \|____\| \| \| \| \| __ \|`
			`\| \|\_/\| \| \ \| \| \| \| \| \| \|`
			`\|___\| \|__________\| \____________________\| \|___\| \|___\| \|___\|`
			```
Update README.md 2019-08-24 19:51:37 +02:00
Rewrite program in Rust 2019-08-23 05:17:15 +02:00			`A data hoarder's 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.`
first commit 2017-02-20 08:51:24 +01:00
Update README.md 2019-08-25 23:28:46 +02:00			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.
first commit 2017-02-20 08:51:24 +01:00
Update README.md 2019-08-25 23:28:46 +02:00			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.
first commit 2017-02-20 08:51:24 +01:00
Update README.md 2019-12-13 01:27:26 +01:00			`## Installation`
first commit 2017-02-20 08:51:24 +01:00
Update README.md 2019-12-13 01:27:26 +01:00			`### From source`
Rewrite program in Rust 2019-08-23 05:17:15 +02:00			`$ git clone https://github.com/Y2Z/monolith.git`
			`$ cd monolith`
cargo clippy 2019-08-23 20:24:45 +02:00			`$ cargo install --path .`
first commit 2017-02-20 08:51:24 +01:00
Update README.md 2020-01-14 09:42:04 +01:00			`### With Homebrew (on macOS and GNU/Linux)`
Update README.md 2019-12-13 01:27:26 +01:00			`$ brew install monolith`

Update README.md 2020-01-14 09:42:04 +01:00			`### Using Snapcraft (on GNU/Linux)`
			`$ snap install monolith`

Update README.md 2019-12-13 01:27:26 +01:00			`## Usage`
add option for saving output to file 2019-12-26 06:41:03 +01:00			`$ monolith https://lyrics.github.io/db/p/portishead/dummy/roads/ -o portishead-roads-lyrics.html`
first commit 2017-02-20 08:51:24 +01:00
Update README.md 2019-12-13 01:27:26 +01:00			`## Options`
Add CSP isolation, no CSS, and no iframe options 2019-09-22 02:06:00 +02:00			- `-c`: Ignore styles
			- `-f`: Exclude iframes
Update README.md 2019-08-23 11:15:21 +02:00			- `-i`: Remove images
Add CSP isolation, no CSS, and no iframe options 2019-09-22 02:06:00 +02:00			- `-I`: Isolate document
Update README.md 2019-08-23 12:09:32 +02:00			- `-j`: Exclude JavaScript
Add flag to ignore errors related to TLS certificates 2019-08-27 05:17:36 +02:00			- `-k`: Accept invalid X.509 (TLS) certificates
add option for saving output to file 2019-12-26 06:41:03 +01:00			- `-o`: Write output to file
Add flag for silent mode 2019-08-25 17:41:30 +02:00			- `-s`: Silent mode
Add -u flag for custom User-Agent 2019-08-23 20:33:18 +02:00			- `-u`: Specify custom User-Agent
first commit 2017-02-20 08:51:24 +01:00
Update README.md 2019-12-13 01:27:26 +01:00			`## Related projects`
add related projects 2019-10-07 13:57:02 +02:00			- `Pagesaver`: https://github.com/distributed-mind/pagesaver
Update README.md 2019-10-08 05:46:08 +02:00			- `SingleFile`: https://github.com/gildas-lormeau/SingleFile
add related projects 2019-10-07 13:57:02 +02:00
Update README.md 2019-12-13 01:27:26 +01:00			`## License`
Rewrite program in Rust 2019-08-23 05:17:15 +02:00			`The Unlicense`

			`<!-- Microtext -->`
			<sub>Keep in mind that `monolith` is not aware of your browser's session</sub>