markdown

package

v0.0.0-...-ac0eb7d Latest Latest Go to latest Published: Oct 10, 2023 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/artyom/notes-server

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func FirstParagraphText(body []byte, doc ast.Node) string
func WordCountAtLeast(text []byte, want int) bool
type HeadingInfo
- func AssignHeaderIDs(body []byte, doc ast.Node) ([]HeadingInfo, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var Markdown = goldmark.New(
	goldmark.WithRendererOptions(html.WithUnsafe()),
	goldmark.WithExtensions(extension.GFM),
	goldmark.WithParserOptions(parser.WithAutoHeadingID()),
)

Functions ¶

func FirstParagraphText ¶

func FirstParagraphText(body []byte, doc ast.Node) string

FirstParagraphText returns the plain text of the first paragraph in a document. If there's anything but headings or html comments before such a paragraph, it returns an empty string.

func WordCountAtLeast ¶

func WordCountAtLeast(text []byte, want int) bool

Types ¶

type HeadingInfo ¶

type HeadingInfo struct {
	Text, Slug string
	Level      int
}

func AssignHeaderIDs ¶

func AssignHeaderIDs(body []byte, doc ast.Node) ([]HeadingInfo, error)

Source Files ¶

View all Source files

pkg.go

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