docgo

README

docgo

Documentation at: https://theplant.github.io/docgo/

Documentation

Index

• func CSSComponentsPack() web.ComponentsPack
• func JSComponentsPack() web.ComponentsPack
• func Markdown(body string) htmlgo.HTMLComponent
• type BoxBuilder
  • func Deprecated(text string) (r *BoxBuilder)
  • func Experiment(text string) (r *BoxBuilder)
  • func Important(text string) (r *BoxBuilder)
  • func Note(text string) (r *BoxBuilder)
  • func Tip(text string) (r *BoxBuilder)
  • func (b *BoxBuilder) Children(vs ...h.HTMLComponent) (r *BoxBuilder)
  • func (b *BoxBuilder) MarshalHTML(ctx context.Context) ([]byte, error)
  • func (b *BoxBuilder) Title(v string) (r *BoxBuilder)
• type Builder
  • func New() (r *Builder)
  • func (b *Builder) ArticleTree() (r *DocNode)
  • func (b *Builder) Assets(prefix string, v embed.FS) (r *Builder)
  • func (b *Builder) Build() (r *Builder)
  • func (b *Builder) BuildStaticSite(dir string)
  • func (b *Builder) Footer(v HTMLComponent) (r *Builder)
  • func (b *Builder) Header(v HTMLComponent) (r *Builder)
  • func (b *Builder) Home(v *DocBuilder) (r *Builder)
  • func (b *Builder) ServeHTTP(w http.ResponseWriter, r *http.Request)
  • func (b *Builder) SitePrefix(v string) (r *Builder)
• type ContentGroupBuilder
  • func ContentGroup(vs ...*DocBuilder) (r *ContentGroupBuilder)
  • func (b *ContentGroupBuilder) MarshalHTML(ctx context.Context) (r []byte, err error)
  • func (b *ContentGroupBuilder) Title(v string) (r *ContentGroupBuilder)
• type ContentTableBuilder
  • func ChildrenTable(vs ...HTMLComponent) (r *ContentTableBuilder)
  • func RelatedTable(vs ...HTMLComponent) (r *ContentTableBuilder)
  • func (b *ContentTableBuilder) MarshalHTML(ctx context.Context) (r []byte, err error)
  • func (b *ContentTableBuilder) Title(v string) (r *ContentTableBuilder)
• type DocBuilder
  • func Doc(vs ...HTMLComponent) (r *DocBuilder)
  • func (b *DocBuilder) AbstractText(v string) (r *DocBuilder)
  • func (b *DocBuilder) ContentGroupItem(ctx context.Context) (r HTMLComponent)
  • func (b *DocBuilder) GetPageTitle() (r string)
  • func (b *DocBuilder) MarshalHTML(ctx context.Context) ([]byte, error)
  • func (b *DocBuilder) Slug(v string) (r *DocBuilder)
  • func (b *DocBuilder) Tables(vs ...HTMLComponent) (r *DocBuilder)
  • func (b *DocBuilder) Title(v string) (r *DocBuilder)
• type DocLinkBuilder
  • func DocLink(doc *DocBuilder) (r *DocLinkBuilder)
  • func (b *DocLinkBuilder) MarshalHTML(ctx context.Context) (r []byte, err error)
• type DocNode
  • func (n *DocNode) AddChild(child *DocNode)
  • func (n *DocNode) GetPageURL() (r string)

Functions

func CSSComponentsPack

func CSSComponentsPack() web.ComponentsPack

func JSComponentsPack

func JSComponentsPack() web.ComponentsPack

func Markdown

func Markdown(body string) htmlgo.HTMLComponent

Types

type BoxBuilder

type BoxBuilder struct {
	// contains filtered or unexported fields
}

func Deprecated

func Deprecated(text string) (r *BoxBuilder)

func Experiment

func Experiment(text string) (r *BoxBuilder)

func Important

func Important(text string) (r *BoxBuilder)

func Note

func Note(text string) (r *BoxBuilder)

func Tip

func Tip(text string) (r *BoxBuilder)

func (*BoxBuilder) Children

func (b *BoxBuilder) Children(vs ...h.HTMLComponent) (r *BoxBuilder)

func (*BoxBuilder) MarshalHTML

func (b *BoxBuilder) MarshalHTML(ctx context.Context) ([]byte, error)

func (*BoxBuilder) Title

func (b *BoxBuilder) Title(v string) (r *BoxBuilder)

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

func New

func New() (r *Builder)

func (*Builder) ArticleTree

func (b *Builder) ArticleTree() (r *DocNode)

func (*Builder) Assets

func (b *Builder) Assets(prefix string, v embed.FS) (r *Builder)

func (*Builder) Build

func (b *Builder) Build() (r *Builder)

func (*Builder) BuildStaticSite

func (b *Builder) BuildStaticSite(dir string)

func (*Builder) Footer

func (b *Builder) Footer(v HTMLComponent) (r *Builder)

func (*Builder) Header

func (b *Builder) Header(v HTMLComponent) (r *Builder)

func (*Builder) Home

func (b *Builder) Home(v *DocBuilder) (r *Builder)

func (*Builder) ServeHTTP

func (b *Builder) ServeHTTP(w http.ResponseWriter, r *http.Request)

func (*Builder) SitePrefix

func (b *Builder) SitePrefix(v string) (r *Builder)

type ContentGroupBuilder

type ContentGroupBuilder struct {
	// contains filtered or unexported fields
}

func ContentGroup

func ContentGroup(vs ...*DocBuilder) (r *ContentGroupBuilder)

func (*ContentGroupBuilder) MarshalHTML

func (b *ContentGroupBuilder) MarshalHTML(ctx context.Context) (r []byte, err error)

func (*ContentGroupBuilder) Title

func (b *ContentGroupBuilder) Title(v string) (r *ContentGroupBuilder)

type ContentTableBuilder

type ContentTableBuilder struct {
	// contains filtered or unexported fields
}

func ChildrenTable

func ChildrenTable(vs ...HTMLComponent) (r *ContentTableBuilder)

func RelatedTable

func RelatedTable(vs ...HTMLComponent) (r *ContentTableBuilder)

func (*ContentTableBuilder) MarshalHTML

func (b *ContentTableBuilder) MarshalHTML(ctx context.Context) (r []byte, err error)

func (*ContentTableBuilder) Title

func (b *ContentTableBuilder) Title(v string) (r *ContentTableBuilder)

type DocBuilder

type DocBuilder struct {
	// contains filtered or unexported fields
}

func Doc

func Doc(vs ...HTMLComponent) (r *DocBuilder)

func (*DocBuilder) AbstractText

func (b *DocBuilder) AbstractText(v string) (r *DocBuilder)

func (*DocBuilder) ContentGroupItem

func (b *DocBuilder) ContentGroupItem(ctx context.Context) (r HTMLComponent)

func (*DocBuilder) GetPageTitle

func (b *DocBuilder) GetPageTitle() (r string)

func (*DocBuilder) MarshalHTML

func (b *DocBuilder) MarshalHTML(ctx context.Context) ([]byte, error)

func (*DocBuilder) Slug

func (b *DocBuilder) Slug(v string) (r *DocBuilder)

func (*DocBuilder) Tables

func (b *DocBuilder) Tables(vs ...HTMLComponent) (r *DocBuilder)

func (*DocBuilder) Title

func (b *DocBuilder) Title(v string) (r *DocBuilder)

type DocLinkBuilder

type DocLinkBuilder struct {
	// contains filtered or unexported fields
}

func DocLink

func DocLink(doc *DocBuilder) (r *DocLinkBuilder)

func (*DocLinkBuilder) MarshalHTML

func (b *DocLinkBuilder) MarshalHTML(ctx context.Context) (r []byte, err error)

type DocNode

type DocNode struct {
	Title      string
	Abstract   string
	Slug       string
	URL        string
	Doc        *DocBuilder `json:"-"`
	ParentNode *DocNode    `json:"-"`
	ChildNodes []*DocNode
}

func (*DocNode) AddChild

func (n *DocNode) AddChild(child *DocNode)

func (*DocNode) GetPageURL

func (n *DocNode) GetPageURL() (r string)