hugo: Index | Files

package goldmark_config

import ""

Package goldmark_config holds Goldmark related configuration.


Package Files



const (
    AutoHeadingIDTypeGitHub      = "github"
    AutoHeadingIDTypeGitHubAscii = "github-ascii"
    AutoHeadingIDTypeBlackfriday = "blackfriday"


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.

type Config Uses

type Config struct {
    Renderer   Renderer
    Parser     Parser
    Extensions Extensions

Config configures Goldmark.

type Extensions Uses

type Extensions struct {
    Typographer    bool
    Footnote       bool
    DefinitionList bool

    // GitHub flavored markdown
    Table         bool
    Strikethrough bool
    Linkify       bool
    TaskList      bool

type Parser Uses

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 Uses

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

Package goldmark_config is imported by 6 packages. Updated 2020-01-09. Refresh now. Tools for package owners.