export

package
v0.21.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 15, 2026 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

Package export writes one Markdown file as an HTML page.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Options

type Options struct {
	Input  string
	Output string
	Mode   markdown.Mode
	Width  markdown.Width
	// Force replaces an existing output file; without it an existing output is
	// an error.
	Force bool
}

Options configures a single-file Markdown export.

type Result

type Result struct {
	Output string
}

Result reports the HTML file produced by a successful export.

func Run

func Run(ctx context.Context, options Options) (Result, error)

Run validates options, renders one Markdown file, and writes the HTML page. The output always lands in the Markdown file's own directory — local images and relative links keep their original references, so the whole asset model needs no copying, rewriting, or conflict detection.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL