monolith/README.md

101 lines
3.9 KiB
Markdown
Raw Normal View History

[![Monolith Build Status for GNU/Linux](https://github.com/Y2Z/monolith/workflows/GNU%2FLinux/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AGNU%2FLinux)
[![Monolith Build Status for macOS](https://github.com/Y2Z/monolith/workflows/macOS/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AmacOS)
[![Monolith Build Status for Windows](https://github.com/Y2Z/monolith/workflows/Windows/badge.svg)](https://github.com/Y2Z/monolith/actions?query=workflow%3AWindows)
2019-10-08 05:46:08 +02:00
```
2020-06-18 06:19:16 +02:00
_____ ______________ __________ ___________________ ___
| \ / \ | | | | | |
| \_/ __ \_| __ | | ___ ___ |__| |
| | | | | | | | | | | |
| |\ /| |__| _ |__| |____| | | | | __ |
| | \___/ | | \ | | | | | | |
|___| |__________| \_____________________| |___| |___| |___|
2019-10-08 05:46:08 +02:00
```
2019-08-24 19:51:37 +02:00
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.
2017-02-20 08:51:24 +01: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
#### Via 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-06-17 13:42:10 +02:00
#### Using Ports collection (on FreeBSD and TrueOS)
$ cd /usr/ports/www/monolith/
$ make install clean
2020-07-13 07:16:38 +02:00
#### Using pre-built binaries (Windows, ARM-based devices, etc)
Every [release](https://github.com/Y2Z/monolith/releases) contains pre-built binaries for Windows, GNU/Linux, as well as platforms with non-standart CPU architecture.
2020-04-05 01:05:49 +02:00
#### From source
2019-12-26 01:00:58 +01:00
2020-04-28 15:07:47 +02:00
Dependency: `libssl-dev`
2019-12-26 01:00:58 +01:00
2020-04-05 01:05:49 +02:00
$ git clone https://github.com/Y2Z/monolith.git
$ cd monolith
$ make install
2020-06-19 09:51:19 +02:00
#### Using Containers
The guide can be found [here](docs/containers.md)
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
- `-a`: Exclude audio sources
- `-b`: Use custom base URL
- `-c`: Exclude CSS
- `-e`: Ignore network errors
- `-f`: Omit frames
- `-F`: Exclude web fonts
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
2020-12-10 03:23:17 +01:00
- `-M`: Don't add timestamp and URL information
2019-12-26 06:41:03 +01:00
- `-o`: Write output to file
2020-06-25 23:38:39 +02:00
- `-s`: Be quiet
2020-05-23 09:16:08 +02:00
- `-t`: Adjust network request timeout
- `-u`: Provide custom User-Agent
- `-v`: Exclude videos
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-12-13 19:42:41 +01:00
## 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
- `Hako`: https://github.com/dmpop/hako
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 browsers session</sub>