subheaders

README

goldmark-subheaders

Goldmark extension for markdown sub-headers.

## Title
## Subtitle
text

## Subtitle 1

## Subtitle 2

text

<header>
<h2>Title</h2>
<p>Subtitle</p>
</header>
<p>text</p>
<h2>Subtitle 1</h2>
<h2>Subtitle 2</h2>
<p>text</p>

// add sub-headers support to golmark markdown parser
md := goldmark.New(subheaders.Option)

Documentation

Overview

Package subheaders is a extension for the goldmark (http://github.com/yuin/goldmark).

This extension adds support for subheaders in markdown.

# Header
# Sub-header text

Example

package main

import (
	"log"
	"os"

	subheaders "github.com/mdigger/goldmark-subheaders"
	"github.com/yuin/goldmark"
)

func main() {
	var md = goldmark.New(subheaders.Option)
	var source = []byte(`
## Title
## Subtitle
text

## Subtitle 1

## Subtitle 2

text
`)
	err := md.Convert(source, os.Stdout)
	if err != nil {
		log.Fatal(err)
	}
}

Output:

<header>
<h2>Title</h2>
<p>Subtitle</p>
</header>
<p>text</p>
<h2>Subtitle 1</h2>
<h2>Subtitle 2</h2>
<p>text</p>

Index

• Variables
• type HeaderBlock
  • func (n *HeaderBlock) Dump(source []byte, level int)
  • func (n *HeaderBlock) Extend(m goldmark.Markdown)
  • func (n *HeaderBlock) Kind() ast.NodeKind
  • func (n *HeaderBlock) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
  • func (n *HeaderBlock) Transform(doc *ast.Document, reader text.Reader, pc parser.Context)

Examples

• Package

Variables

var Extension = new(HeaderBlock)

Extension is a initialized goldmark extension for sub-headers support.

var KindHeaderBlock = ast.NewNodeKind("HeaderBlock")

KindHeaderBlock is a NodeKind of the TextBlock node.

var Option = goldmark.WithExtensions(Extension)

Option is goldmark.Option for sub-headers extension.

Types

type HeaderBlock

type HeaderBlock struct {
	ast.BaseBlock
}

HeaderBlock is a HTML5 Header block.

func (*HeaderBlock) Dump

func (n *HeaderBlock) Dump(source []byte, level int)

Dump implements Node.Dump.

func (*HeaderBlock) Extend

func (n *HeaderBlock) Extend(m goldmark.Markdown)

Extend implement goldmark.Extender interface.

func (*HeaderBlock) Kind

func (n *HeaderBlock) Kind() ast.NodeKind

Kind implements Node.Kind.

func (*HeaderBlock) RegisterFuncs

func (n *HeaderBlock) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

RegisterFuncs implement renderer.NodeRenderer interface.

func (*HeaderBlock) Transform

func (n *HeaderBlock) Transform(doc *ast.Document, reader text.Reader, pc parser.Context)

Transform combines consecutive headings of one level in one header block.