render

Documentation

Overview

Package render writes pawndoc output formats.

Index

• func HTML(w io.Writer, pkg doc.Package) error
• func JSON(w io.Writer, pkg doc.Package) error
• func Markdown(w io.Writer, pkg doc.Package) error
• type SearchEntry
  • func SearchIndex(pkg doc.Package) []SearchEntry

Functions

func HTML

func HTML(w io.Writer, pkg doc.Package) error

HTML writes a standalone HTML document.

func JSON

func JSON(w io.Writer, pkg doc.Package) error

JSON writes the renderer-neutral model.

func Markdown

func Markdown(w io.Writer, pkg doc.Package) error

Markdown writes a Markdown document.

Types

type SearchEntry

type SearchEntry struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	Kind    string `json:"kind"`
	Summary string `json:"summary,omitempty"`
}

SearchEntry is a compact symbol record for search indexes.

func SearchIndex

func SearchIndex(pkg doc.Package) []SearchEntry

SearchIndex builds sorted search records.