package goldmark_config
import "github.com/gohugoio/hugo/markup/goldmark/goldmark_config"
Package goldmark_config holds Goldmark related configuration.
Index ¶
- Constants
- Variables
- type CJK
- type Config
- type Extensions
- type Parser
- type ParserAttribute
- type Renderer
- type Typographer
Constants ¶
const ( AutoHeadingIDTypeGitHub = "github" AutoHeadingIDTypeGitHubAscii = "github-ascii" AutoHeadingIDTypeBlackfriday = "blackfriday" )
Variables ¶
var Default = Config{ Extensions: Extensions{ Typographer: Typographer{ Disable: false, LeftSingleQuote: "‘", RightSingleQuote: "’", LeftDoubleQuote: "“", RightDoubleQuote: "”", EnDash: "–", EmDash: "—", Ellipsis: "…", LeftAngleQuote: "«", RightAngleQuote: "»", Apostrophe: "’", }, Footnote: true, DefinitionList: true, Table: true, Strikethrough: true, Linkify: true, LinkifyProtocol: "https", TaskList: true, CJK: CJK{ Enable: false, EastAsianLineBreaks: false, EastAsianLineBreaksStyle: "simple", EscapedSpace: false, }, }, Renderer: Renderer{ Unsafe: false, }, Parser: Parser{ AutoHeadingID: true, AutoHeadingIDType: AutoHeadingIDTypeGitHub, WrapStandAloneImageWithinParagraph: true, Attribute: ParserAttribute{ Title: true, Block: false, }, }, }
Default holds the default Goldmark configuration.
Types ¶
type CJK ¶
type CJK struct { // Whether to enable CJK support. Enable bool // Whether softline breaks between east asian wide characters should be ignored. EastAsianLineBreaks bool // Styles of Line Breaking of EastAsianLineBreaks: "simple" or "css3draft" EastAsianLineBreaksStyle string // Whether a '\' escaped half-space(0x20) should not be rendered. EscapedSpace bool }
type Config ¶
type Config struct { Renderer Renderer Parser Parser Extensions Extensions }
Config configures Goldmark.
type Extensions ¶
type Extensions struct { Typographer Typographer Footnote bool DefinitionList bool // GitHub flavored markdown Table bool Strikethrough bool Linkify bool LinkifyProtocol string TaskList bool CJK CJK }
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 ParserAttribute // Whether to wrap stand-alone images within a paragraph or not. WrapStandAloneImageWithinParagraph bool }
type ParserAttribute ¶
type ParserAttribute struct { // Enables custom attributes for titles. Title bool // Enables custom attributeds for blocks. Block 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 }
type Typographer ¶
type Typographer struct { // Whether to disable typographer. Disable bool // Value used for left single quote. LeftSingleQuote string // Value used for right single quote. RightSingleQuote string // Value used for left double quote. LeftDoubleQuote string // Value used for right double quote. RightDoubleQuote string // Value used for en dash. EnDash string // Value used for em dash. EmDash string // Value used for ellipsis. Ellipsis string // Value used for left angle quote. LeftAngleQuote string // Value used for right angle quote. RightAngleQuote string // Value used for apostrophe. Apostrophe string }
Typographer holds typographer configuration.
Source Files ¶
- Version
- v0.120.4
- Published
- Nov 8, 2023
- Platform
- linux/amd64
- Last checked
- 21 minutes ago –
Tools for package owners.