Mirror/monolith
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Sunshine 2020-03-05 05:15:13 -05:00 committed by GitHub
parent a445098409
commit a92bba4ec5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -17,6 +17,7 @@ Unlike the conventional "Save page as", `monolith` not only saves the target doc
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
@ -34,10 +35,12 @@ If compared to saving websites with `wget -mpk`, this tool embeds all assets as
#### Via Docker
The guide can be found [here](https://github.com/Y2Z/monolith/wiki/Using-containers)
---------------------------------------------------
## Usage
$ monolith https://lyrics.github.io/db/P/Portishead/Dummy/Roads/ -o portishead-roads-lyrics.html
---------------------------------------------------
## Options
- `-c`: Ignore styles
@ -51,24 +54,29 @@ The guide can be found [here](https://github.com/Y2Z/monolith/wiki/Using-contain
- `-t`: Set custom network request timeout
- `-u`: Provide own User-Agent
---------------------------------------------------
## HTTPS and HTTP proxies
Please set `https_proxy`, `http_proxy`, and `no_proxy` environment variables.
---------------------------------------------------
## Contributing
Please open an issue if something is wrong, that helps make this project better.
---------------------------------------------------
## Related projects
- `Monolith Chrome Extension`: https://github.com/rhysd/monolith-of-web
- `Pagesaver`: https://github.com/distributed-mind/pagesaver
- `Personal WayBack Machine`: https://github.com/popey/pwbm
---------------------------------------------------
## License
The Unlicense
---------------------------------------------------
<!-- Microtext -->
<sub>Keep in mind that `monolith` is not aware of your browser's session</sub>