goldmark

package
v0.0.0-...-b204764 Latest Latest
Warning

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

Go to latest
Published: Dec 12, 2024 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package goldmark provides extensions to the Goldmark Markdown interface.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Extension

type Extension struct {
	Extenders     []goldmark.Extender
	ParserOptions []parser.Option
}

Extension contains Goldmark extensions.

func NewWebsite

func NewWebsite() *Extension

NewWebsite returns an extension to the Goldmark Markdown interface configured to approximate the Grafana website configuration. For list of default extensions: https://gohugo.io/getting-started/configuration-markup/. For the website configuration: https://github.com/grafana/website/blob/master/config/_default/config.yaml#L103-L121

func (*Extension) Extend

func (e *Extension) Extend(md goldmark.Markdown)

Directories

Path Synopsis
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
renderer
markdown
Package renderer implements Goldmark renderer that outputs Markdown.
Package renderer implements Goldmark renderer that outputs Markdown.

Jump to

Keyboard shortcuts

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