monolith/README.md

83 lines
3.1 KiB
Markdown
Raw Normal View History

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)
[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/ae7soyjih8jg2bv7/branch/master?svg=true)](https://ci.appveyor.com/project/snshn/monolith/branch/master)
2019-10-08 05:46:08 +02:00
```
___ ___________ __________ ___________________ ___
| \ / \ | | | | | |
| \_/ __ \_| __ | | ___ ___ |__| |
| | | | | | | | | | | |
| |__| _ |__| |____| | | | | __ |
| |\_/| | \ | | | | | | |
|___| |__________| \____________________| |___| |___| |___|
```
2019-08-24 19:51:37 +02:00
2020-01-21 02:48:34 +01: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.
2017-02-20 08:51:24 +01:00
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.
2017-02-20 08:51:24 +01:00
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.
2017-02-20 08:51:24 +01:00
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-12-13 01:27:26 +01:00
## Installation
2017-02-20 08:51:24 +01:00
2020-03-05 11:11:54 +01:00
#### From source
2019-08-23 05:17:15 +02:00
$ git clone https://github.com/Y2Z/monolith.git
$ cd monolith
2020-02-14 05:47:30 +01:00
$ make install
2017-02-20 08:51:24 +01:00
2020-03-05 11:11:54 +01:00
#### With Homebrew (on macOS and GNU/Linux)
2019-12-13 01:27:26 +01:00
$ brew install monolith
2020-03-05 11:11:54 +01:00
#### Using Snapcraft (on GNU/Linux)
2020-01-14 09:42:04 +01:00
$ snap install monolith
2020-03-05 11:11:54 +01:00
#### Via Docker
2020-03-03 05:56:17 +01:00
The guide can be found [here](https://github.com/Y2Z/monolith/wiki/Using-containers)
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-12-13 01:27:26 +01:00
## Usage
2020-01-21 02:48:34 +01:00
$ monolith https://lyrics.github.io/db/P/Portishead/Dummy/Roads/ -o portishead-roads-lyrics.html
2017-02-20 08:51:24 +01:00
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-12-13 01:27:26 +01:00
## Options
- `-c`: Ignore styles
2020-02-24 06:06:31 +01:00
- `-f`: Exclude frames and iframes
2019-08-23 11:15:21 +02:00
- `-i`: Remove images
2020-02-15 07:33:20 +01:00
- `-I`: Isolate the document
2019-08-23 12:09:32 +02:00
- `-j`: Exclude JavaScript
- `-k`: Accept invalid X.509 (TLS) certificates
2019-12-26 06:41:03 +01:00
- `-o`: Write output to file
2019-08-25 17:41:30 +02:00
- `-s`: Silent mode
2020-02-12 14:38:08 +01:00
- `-t`: Set custom network request timeout
2020-02-15 07:33:20 +01:00
- `-u`: Provide own User-Agent
2017-02-20 08:51:24 +01:00
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2020-01-21 05:02:45 +01:00
## HTTPS and HTTP proxies
Please set `https_proxy`, `http_proxy`, and `no_proxy` environment variables.
2020-01-21 05:02:45 +01:00
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2020-01-21 02:48:34 +01:00
## Contributing
Please open an issue if something is wrong, that helps make this project better.
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-12-13 01:27:26 +01:00
## Related projects
2020-01-21 02:48:34 +01:00
- `Monolith Chrome Extension`: https://github.com/rhysd/monolith-of-web
2019-10-07 13:57:02 +02:00
- `Pagesaver`: https://github.com/distributed-mind/pagesaver
2020-01-21 02:48:34 +01:00
- `Personal WayBack Machine`: https://github.com/popey/pwbm
2019-10-07 13:57:02 +02:00
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-12-13 01:27:26 +01:00
## License
2019-08-23 05:17:15 +02:00
The Unlicense
2020-03-05 11:15:13 +01:00
---------------------------------------------------
2020-03-03 05:56:17 +01:00
2019-08-23 05:17:15 +02:00
<!-- Microtext -->
<sub>Keep in mind that `monolith` is not aware of your browser's session</sub>