linkrewrite

package
v0.8.2 Latest Latest
Warning

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

 Go to latest Published: Jul 24, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package linkrewrite handles Markdown link rewriting across different output formats. It transforms .md file references in HTML content to appropriate targets (anchor links for single-page, page links for multi-page site).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NormalizePath 

func NormalizePath(path string) string

NormalizePath normalizes a chapter file path for consistent map lookups. It cleans the path, converts to forward slashes, and lowercases the file extension so that "chapter.MD" and "chapter.md" resolve to the same key. 

func RewriteLinks(htmlContent string, currentFile string, targets map[string]Target, mode Mode) string

RewriteLinks rewrites Markdown .md links in HTML content to the appropriate targets based on the output mode.

Types

type Mode 

type Mode string

Mode determines how links are rewritten. 

const (
	// ModeSingle rewrites .md links to #anchor links within a single page.
	ModeSingle Mode = "single"
	// ModeSite rewrites .md links to separate page filenames.
	ModeSite Mode = "site"
	// ModeEpub rewrites .md links to the flat <chapterID>.xhtml documents an
	// ePub's OEBPS directory is made of. Without it a cross-chapter link ships
	// as a dead .md href, which epubcheck reports as RSC-007 and readers
	// silently ignore.
	ModeEpub Mode = "epub"
)

type Target 

type Target struct {
	ChapterID    string
	PageFilename string
}

Target describes the rewrite destination for a chapter.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.