PommaLabs.HtmlArk
1.1.0
Prefix Reserved
See the version list below for details.
dotnet add package PommaLabs.HtmlArk --version 1.1.0
NuGet\Install-Package PommaLabs.HtmlArk -Version 1.1.0
<PackageReference Include="PommaLabs.HtmlArk" Version="1.1.0" />
paket add PommaLabs.HtmlArk --version 1.1.0
#r "nuget: PommaLabs.HtmlArk, 1.1.0"
// Install PommaLabs.HtmlArk as a Cake Addin #addin nuget:?package=PommaLabs.HtmlArk&version=1.1.0 // Install PommaLabs.HtmlArk as a Cake Tool #tool nuget:?package=PommaLabs.HtmlArk&version=1.1.0
HtmlArk
Embeds images, fonts, CSS and JavaScript into an HTML file. Resources are embedded using data URIs.
This project is a .NET rewrite of the homonymous Python project, from which the command line interface has been copied in order to ease interoperability.
Most disclaimers which were valid for the original library apply here too:
- ⚠️ HtmlArk should be used with trusted HTML pages only or in a sandboxed environment. Untrusted HTML pages might contain resource links which are valid for HtmlArk but they might pose a serious security risk to your organization.
- HtmlArk works with static HTML pages only. If an image or other resource is loaded with JavaScript, HtmlArk won't even know it exists.
- Most browsers support data URIs, but as usual IE support might be less than ideal. Check data URIs compatibility on Can I use.
HtmlArk can be used to "pack" web pages into single HTML files. However, HtmlArk is not a crawler, so it must be paired with one in order to pack entire websites.
💡 If you plan to serve packed web pages, please remember to turn on GZIP compression. It usually yields good results and it helps to reduce download size.
Table of Contents
Install
NuGet package PommaLabs.HtmlArk is available for download:
dotnet add package PommaLabs.HtmlArk
HtmlArk .NET tool can be installed with following command:
dotnet tool install PommaLabs.HtmlArk.Tool
Usage
Library
As a library, HtmlArk can be included with the following using statement in your class:
using PommaLabs.HtmlArk;
And then, it can be used like this, for example:
IHtmlArchiver htmlArchiver = new HtmlArchiver(NullLogger<HtmlArchiver>.Instance);
string archivedHtml = await htmlArchiver.ArchiveAsync(new Uri("https://www.example.com/"));
If you use dependency injection, it can be registered this way:
services.AddHtmlArchiver(); // Maps IHtmlArchiver to HtmlArchiver as singleton.
Tool
HtmlArk .NET tool accepts the following command line arguments:
-M, --http-client-max-resource-size How many bytes can be downloaded for each resource.
-T, --http-client-timeout Timeout of the internal HTTP client.
-A, --ignore-audios Ignores audios during archival.
-C, --ignore-css Ignores style sheets during archival.
-E, --ignore-errors Ignores unreadable resources.
-I, --ignore-images Ignores images during archival.
-J, --ignore-js Ignores external JavaScript during archival.
-V, --ignore-videos Ignores videos during archival.
-m, --minify Minifies output HTML.
-o, --output Output file path. If not specified, output will be written to STDOUT.
-v, --verbose Prints detailed information during HTML archival.
--help Display this help screen.
--version Display version information.
input (pos. 0) Required. Input URI or file path.
Interface is modeled after the original Python project, so it should be pretty easy to switch between them.
Maintainers
Contributing
PRs accepted.
Small note: If editing the README, please conform to the standard-readme specification.
License
MIT © 2020-2021 Alessio Parma
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 is compatible. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 is compatible. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.6.1
- AngleSharp (>= 0.16.0)
- AngleSharp.Css (>= 0.16.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 2.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 2.0.0)
- PommaLabs.MimeTypes (>= 2.4.0)
-
.NETFramework 4.7.2
- AngleSharp (>= 0.16.0)
- AngleSharp.Css (>= 0.16.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 2.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 2.0.0)
- PommaLabs.MimeTypes (>= 2.4.0)
-
.NETStandard 2.0
- AngleSharp (>= 0.16.0)
- AngleSharp.Css (>= 0.16.1)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 2.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 2.0.0)
- PommaLabs.MimeTypes (>= 2.4.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.