markdown

package
v0.0.0-...-0f28876 Latest Latest
Warning

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

 Go to latest Published: Jul 21, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package markdown handles Markdown to HTML rendering.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ExtractTitle 

func ExtractTitle(source []byte) string

ExtractTitle extracts the first heading from Markdown source.

Types

type Heading 

type Heading struct {
	Level int
	Text  string
}

Heading represents a Markdown heading.

func ExtractHeadings 

func ExtractHeadings(source []byte) []Heading

ExtractHeadings extracts all headings from Markdown source. 

type Link struct {
	URL   string
	Title string
}

Link represents a Markdown link. 

func ExtractLinks(source []byte) []Link

ExtractLinks extracts all links from Markdown source.

type Page 

type Page struct {
	Slug        string
	Title       string
	Content     string
	Headings    []Heading
	FrontMatter map[string]string
	FilePath    string
}

Page represents a content page.

func ParsePage 

func ParsePage(path string) (*Page, error)

ParsePage parses a Markdown file with optional front matter.

type Renderer 

type Renderer struct {
	// contains filtered or unexported fields
}

Renderer converts Markdown to HTML.

func NewRenderer 

func NewRenderer() *Renderer

NewRenderer creates a new Markdown renderer.

func (*Renderer) Render 

func (r *Renderer) Render(source []byte) ([]byte, error)

Render converts Markdown bytes to HTML.

func (*Renderer) RenderFile 

func (r *Renderer) RenderFile(path string) ([]byte, error)

RenderFile renders a Markdown file to HTML.

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.