website: golang.org/x/website/markdown Index | Files

package markdown

import "golang.org/x/website/markdown"

Package markdown provides a wrapper for rendering Markdown. It is intended to be used by x/website and x/blog so that we can use the same renderer with the same settings.

This package is not intended for general use, and its API is not guaranteed to be stable.

Index

Package Files

markdown.go

func Render Uses

func Render(src []byte) ([]byte, error)

Render converts a limited and opinionated flavor of Markdown (compliant with CommonMark 0.29) to HTML for the purposes of golang.org websites. This should not be adjusted except for the needs of *.golang.org.

The Markdown source may contain raw HTML and Go templates. Sanitization of untrusted content is not performed: the caller is responsible for ensuring that only trusted content is provided.

Package markdown imports 3 packages (graph) and is imported by 1 packages. Updated 2020-04-08. Refresh now. Tools for package owners.