monolith/README.md

30 lines
1.1 KiB
Markdown
Raw Normal View History

2017-02-20 08:47:35 +01:00
# monolith
2017-02-20 09:28:18 +01:00
A data hoarder's dream come true: bundle any web page into a stand-alone HTML file.
2017-03-04 14:05:52 +01:00
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
2017-03-04 14:04:56 +01:00
Unlike conventional "Save page as …", `monolith` not only saves the target document,
2017-03-04 14:05:52 +01:00
but embeds JavaScript, CSS and image assets **all at once**, resulting in a single HTML5 document that is a joy to store and share.
2017-02-20 08:51:24 +01:00
Works both on remote and local targets.
2017-03-04 14:05:52 +01:00
If compared to saving websites with `wget -mpk`, `monolith` embeds all assets as data-URIs and therefore would display the page exactly the same at any given time, being completely independent from the Internet.
2017-02-20 08:51:24 +01:00
However, keep in mind that `monolith` is not aware of your browser's session.
### Installing/Updating
$ sudo npm install -g https://github.com/Y2Z/monolith.git
2017-02-20 08:51:24 +01:00
### Usage
2017-02-20 08:55:52 +01:00
$ monolith https://github.com > github.html
2017-02-20 08:51:24 +01:00
<!-- or -->
2017-02-20 09:28:18 +01:00
2017-02-20 08:51:24 +01:00
<!-- cat local.html | monolith - > local.html -->
### Options
2017-02-20 09:11:58 +01:00
- `-u`: output the result as one big data-URI
2017-02-20 08:55:52 +01:00
- `-q`: be quiet
2017-02-20 08:51:24 +01:00
<!-- - `-a`: fix anchor href="" attributes for remote documents -->
### License
GPLv3