docs

Documentation

Index

• Variables
• func Render(md string) (string, error)
• func WithBaseURL() glamour.TermRendererOption
• func WithWrap(w int) glamour.TermRendererOption
• func WithoutIndentation() glamour.TermRendererOption

Variables

var FS embed.FS

Functions

func Render

func Render(md string) (string, error)

Render returns the markdown rendered as a string. It does a series of checks to detect terminal width, color scheme, etc. to achieve the best possible formatting.

func WithBaseURL

func WithBaseURL() glamour.TermRendererOption

WithBaseURL sets the base URL for relative links to the location of the GitHub project.

func WithWrap

func WithWrap(w int) glamour.TermRendererOption

WithWrap sets the word wrap to w columns.

func WithoutIndentation

func WithoutIndentation() glamour.TermRendererOption

WithoutIndentation removes margins to produce dense output.