package goldmark_config
import "github.com/gohugoio/hugo/markup/goldmark/goldmark_config"
Package goldmark_config holds Goldmark related configuration.
Index ¶
Constants ¶
const ( AutoHeadingIDTypeGitHub = "github" AutoHeadingIDTypeGitHubAscii = "github-ascii" AutoHeadingIDTypeBlackfriday = "blackfriday" )
Variables ¶
var Default = Config{ Extensions: Extensions{ Typographer: true, Footnote: true, DefinitionList: true, Table: true, Strikethrough: true, Linkify: true, TaskList: true, }, Renderer: Renderer{ Unsafe: false, }, Parser: Parser{ AutoHeadingID: true, AutoHeadingIDType: AutoHeadingIDTypeGitHub, Attribute: true, }, }
DefaultConfig holds the default Goldmark configuration.
Types ¶
type Config ¶
type Config struct { Renderer Renderer Parser Parser Extensions Extensions }
Config configures Goldmark.
type Extensions ¶
type Extensions struct { Typographer bool Footnote bool DefinitionList bool // GitHub flavored markdown Table bool Strikethrough bool Linkify bool TaskList bool }
type Parser ¶
type Parser struct { // Enables custom heading ids and // auto generated heading ids. AutoHeadingID bool // The strategy to use when generating heading IDs. // Available options are "github", "github-ascii". // Default is "github", which will create GitHub-compatible anchor names. AutoHeadingIDType string // Enables custom attributes. Attribute bool }
type Renderer ¶
type Renderer struct { // Whether softline breaks should be rendered as '<br>' HardWraps bool // XHTML instead of HTML5. XHTML bool // Allow raw HTML etc. Unsafe bool }
Source Files ¶
- Version
- v0.78.2
- Published
- Nov 13, 2020
- Platform
- linux/amd64
- Last checked
- 51 minutes ago –
Tools for package owners.