drafty

Documentation

Overview

Package drafty contains utilities for conversion from Drafty to plain text.

Index

• func PlainText(content interface{}) (string, error)
• func Preview(content interface{}, length int) (string, error)

Functions

func PlainText

func PlainText(content interface{}) (string, error)

PlainText converts drafty document to plain text with some basic markdown-like formatting. Deprecated: use Preview for new development.

func Preview

func Preview(content interface{}, length int) (string, error)

Preview shortens Drafty to the specified length (in runes), removes quoted text, leading line breaks, and large content from entities making them suitable for a one-line preview, for example for showing in push notifications. The return value is a Drafty document encoded as JSON string.