dotnet tool install --global PommaLabs.HtmlArk.Tool --version 1.5.0
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local PommaLabs.HtmlArk.Tool --version 1.5.0
nuke :add-package PommaLabs.HtmlArk.Tool --version 1.5.0
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.
- 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
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
As a library, HtmlArk can be included with the following
using statement in your class:
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.
HtmlArk .NET tool accepts the following command line arguments:
Interface is modeled after the original Python project, so it should be pretty easy to switch between them.
Small note: If editing the README, please conform to the standard-readme specification.
Visual Studio Code, with Remote Containers extension, is the recommended way to work on this project.
A development container has been configured with all required tools.
Visual Studio Community is also supported
and an updated solution file,
htmlark.sln, has been provided.
When opening the development container, dependencies should be automatically restored.
Anyway, dependencies can be restored with following command:
Tests can be run with following command:
Tests can also be run with following command, which collects coverage information:
./build.sh --target run-tests
MIT © 2020-2023 Alessio Parma
|Product||Versions Compatible and additional computed target framework versions.|
|.NET||net6.0 is compatible. 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.|
This package has no dependencies.