Save HTML Document in Java

To save an HTML document in Java, create or load an HTMLDocument, edit the DOM if needed, and call HTMLDocument.save(). Use HTMLSaveOptions to control linked resources or HTMLSaveFormat to save HTML as MHTML or Markdown. Use SVGDocument.save() for standalone SVG content.

After creating or editing an HTMLDocument, you can save its current DOM state to an HTML-like format. The com.aspose.html.saving package provides options for controlling the output and associated resources.

Saving and conversion solve different tasks:

• Document saving writes HTML, MHTML, Markdown, or SVG content with the corresponding document save() method and save options.
• Document conversion produces a visual output such as PDF, XPS, DOCX, or an image. For those workflows, use the HTML Converter and format-specific save options.

API	Use it to
HTMLDocument.save()	Save the current HTML document by path, local URL, format, options, or resource handler.
HTMLSaveOptions	Configure HTML output and access resource handling settings.
ResourceHandlingOptions	Control linked resource handling, URL restrictions, and page handling depth.
HTMLSaveFormat	Select HTML, MHTML, or Markdown output for a format-based save overload.
SVGDocument	Load, edit, and save a standalone SVG document.

Save HTML to a File

The simplest workflow creates an HTML document, adds content to its DOM, and saves the result as a local .html file.

To save an HTML document to a file in Java:

1. Create or load an HTMLDocument.
2. Add or modify document content.
3. Call document.save(path) with the target HTML file path.
4. Open or process the saved HTML file as required.

The following example creates a text node, adds it to the document body, and saves save-to-file.html:

// Save HTML to a file using Java

// Initialize an empty HTML document
HTMLDocument document = new HTMLDocument();

// Create a text node and add it to the document
Text text = document.createTextNode("Hello, World!");
document.getBody().appendChild(text);

// Save the HTML document to a file
document.save("save-to-file.html");

Save HTML with Linked Resources

HTML documents can reference stylesheets, images, scripts, fonts, and other pages. Use HTMLSaveOptions.getResourceHandlingOptions() to control how these resources are processed.

To save HTML and process a directly linked page:

1. Prepare the main HTML document and the page it references.
2. Load the main file into an HTMLDocument.
3. Create HTMLSaveOptions.
4. Set MaxHandlingDepth to 1 through getResourceHandlingOptions().
5. Call document.save(path, options).

The following example creates an HTML file that links to linked.html. It sets the maximum page handling depth to 1, so directly referenced pages can be processed during saving:

// Save HTML with a linked resources using Java

// Prepare a simple HTML file with a linked document
java.nio.file.Files.write(
        java.nio.file.Paths.get("save-with-linked-file.html"),
        "<p>Hello, World!</p><a href='linked.html'>linked file</a>".getBytes());

// Prepare a simple linked HTML file
java.nio.file.Files.write(java.nio.file.Paths.get("linked.html"),
        "<p>Hello, linked file!</p>".getBytes());

// Load the "save-with-linked-file.html" into memory
HTMLDocument document = new HTMLDocument("save-with-linked-file.html");

// Create an instance of the HTMLSaveOptions class
HTMLSaveOptions options = new HTMLSaveOptions();

// Set the maximum page handling depth to 1 so that directly referenced pages can be processed during saving
options.getResourceHandlingOptions().setMaxHandlingDepth(1);

// Save the document with the save options
document.save("save-with-linked-file_out.html", options);

The default maximum page handling depth is 0, which limits processing to the current document. A value of 1 includes directly referenced pages; -1 enables processing at any depth. Resource and page URL restrictions can still limit which referenced items are handled.

Save HTML as MHTML or Markdown

The HTMLSaveFormat enumeration selects an HTML-like output format when calling a compatible save() overload.

Save HTML to MHTML

MHTML packages an HTML document and handled resources into a web archive. It is useful when you need a portable archive rather than a main HTML file with an adjacent resource folder.

To save HTML as MHTML in Java:

1. Create or load an HTMLDocument.
2. Choose a target path with the .mht or .mhtml extension.
3. Call document.save(path, HTMLSaveFormat.MHTML).
4. Use MHTMLSaveOptions instead when page depth or resource handling requires customization.

The following example loads an HTML file and saves it in MHTML format:

// Save HTML as MHTML using Java

// Prepare a simple HTML file with a linked document
java.nio.file.Files.write(
        java.nio.file.Paths.get("document.html"),
        "<p>Hello, World!</p><a href='linked-file.html'>linked file</a>".getBytes());

// Prepare a simple linked HTML file
java.nio.file.Files.write(
        java.nio.file.Paths.get("linked-file.html"),
        "<p>Hello, linked file!</p>".getBytes());

// Load the "document.html" into memory
HTMLDocument document = new HTMLDocument("document.html");

// Save the document to MHTML format
document.save("save-to-MHTML.mht", HTMLSaveFormat.MHTML);

For more control, pass MHTMLSaveOptions to a compatible save() overload and configure its resource handling options. To convert MHTML input to PDF or images, see the MHTML Converter.

Save HTML to Markdown

Markdown is a plain-text markup format suited to editable documentation and content workflows.

To save HTML as Markdown in Java:

1. Create or load an HTMLDocument.
2. Choose the target .md file path.
3. Call document.save(path, HTMLSaveFormat.Markdown).
4. Use the saved Markdown in a text-based publishing workflow.

The following example creates an HTML heading and saves it as save-to-MD.md:

// Save HTML as a Markdown file using Java

// Prepare HTML code
String html_code = "<H2>Hello, World!</H2>";

// Initialize a document from a string variable
HTMLDocument document = new HTMLDocument(html_code, ".");

// Save the document as a Markdown file
document.save("save-to-MD.md", HTMLSaveFormat.Markdown);

For converter-based workflows and additional Markdown settings, see Convert HTML to Markdown in Java.

Save an SVG Document

SVG can be embedded in HTML or processed as a standalone XML-based vector document. Use SVGDocument for a standalone SVG DOM. Its loading, DOM editing, and saving workflows are similar to those of HTMLDocument because both APIs follow DOM concepts.

To save an SVG document in Java:

1. Create or load an SVGDocument.
2. Modify the SVG DOM if needed.
3. Call document.save(path) with a target .svg file.
4. Use the saved file as a standalone SVG document.

The following example creates SVG markup containing three paths and saves it as save-to-SVG.svg:

// Create and save an SVG document using Java

// Prepare SVG code
String code = "<svg xmlns='http://www.w3.org/2000/svg' height='200' width='300'>" +
        "<g fill='none' stroke-width= '10' stroke-dasharray='30 10'>" +
        "<path stroke='red' d='M 25 40 l 215 0' />" +
        "<path stroke='black' d='M 35 80 l 215 0' />" +
        "<path stroke='blue' d='M 45 120 l 215 0' />" +
        "</g>" +
        "</svg>";

// Initialize an SVG instance from the content string
SVGDocument document = new SVGDocument(code, ".");

// Save the SVG file to disk
document.save("save-to-SVG.svg");

Common HTML Saving Issues

Issue	Cause and fix
Linked pages are not included	The default MaxHandlingDepth is 0. Set it to 1 for directly referenced pages or select another appropriate depth.
Images, CSS, scripts, or fonts are missing	Check the resource paths, base URL, resource handling mode, and URL restrictions used by HTMLSaveOptions.
A PDF or image was expected from save()	HTMLDocument.save() is for HTML-like formats. Use the HTML conversion APIs for PDF, XPS, DOCX, or image output.
MHTML or Markdown output was not created	Use the save(path, HTMLSaveFormat) overload and select MHTML or Markdown.
SVG changes were not saved	Apply edits to an SVGDocument and call its save() method with the target SVG path.

FAQ

How do I save an HTML document in Java?

Create or load an HTMLDocument, modify its DOM if needed, and call document.save(path) to write the current document to an HTML file.

Does saving HTML include images and CSS?

The save API can process linked resources. Use HTMLSaveOptions and ResourceHandlingOptions when you need to control whether resources are saved, embedded, or ignored and which URLs may be processed.

How do I save HTML as a single file?

Use document.save(path, HTMLSaveFormat.MHTML) to create an MHTML web archive. If linked pages or resource rules require customization, use MHTMLSaveOptions.

What is the difference between saving and converting HTML?

Saving writes the document to an HTML-like format such as HTML, MHTML, or Markdown. Converting creates another representation such as PDF, XPS, DOCX, or an image.

Other Platforms

• Save HTML Document in C# – save HTML, related resources, MHTML, Markdown, and SVG with Aspose.HTML for .NET.
• Save HTML Document in Python – save HTML documents with Aspose.HTML for Python via .NET.

Related Articles

• Working with HTML Documents in Java – choose a document creation, editing, environment configuration, or saving workflow.
• Create and Load HTML Documents in Java – create or load the document before saving it.
• Edit HTML Document in Java – change DOM nodes, attributes, content, and CSS before saving.
• HTML Converter in Java – convert HTML to PDF, XPS, DOCX, images, MHTML, and Markdown.
• Fine-Tuning Converters – configure format-specific conversion and rendering options.

You can download the complete examples and data files from GitHub.