monolith/README.md

35 lines
1.4 KiB
Markdown
Raw Normal View History

2019-08-24 20:17:45 +02:00
[![Travis CI Build Status](https://travis-ci.org/Y2Z/monolith.svg?branch=master)](https://travis-ci.com/Y2Z/monolith)
2019-08-24 21:01:05 +02:00
[![AppVeyor Build status](https://ci.appveyor.com/api/projects/status/j1v1d96sw952b1ch?svg=true)](https://ci.appveyor.com/project/vflyson/monolith)
# monolith
2019-08-24 19:51:37 +02:00
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.
2017-02-20 08:51:24 +01:00
2019-08-23 05:17:15 +02:00
Unlike 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-23 05:17:15 +02:00
If compared to saving websites with `wget -mpk`, `monolith` embeds all assets as data URLs and therefore displays the saved page exactly the same, being completely separated from the Internet.
2017-02-20 08:51:24 +01:00
2019-08-23 05:17:15 +02:00
<!-- `This program works both on remote and local targets. -->
2017-02-20 08:51:24 +01:00
2019-08-23 05:17:15 +02:00
### Installation
$ git clone https://github.com/Y2Z/monolith.git
$ cd monolith
2019-08-23 20:24:45 +02:00
$ cargo install --path .
2017-02-20 08:51:24 +01:00
### Usage
2019-08-23 09:38:31 +02:00
$ monolith https://lyrics.github.io/db/p/portishead/dummy/roads/ > portishead-roads-lyrics.html
2017-02-20 08:51:24 +01:00
### Options
2019-08-23 11:15:21 +02:00
- `-i`: Remove images
2019-08-23 12:09:32 +02:00
- `-j`: Exclude JavaScript
2019-08-23 20:33:18 +02:00
- `-u`: Specify custom User-Agent
2017-02-20 08:51:24 +01:00
### License
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>