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
- type Builder
- 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) DocTree(vs ...interface{}) (r *Builder)
- func (b *Builder) MainPageTitle(v string) (r *Builder)
- func (b *Builder) ServeHTTP(w http.ResponseWriter, r *http.Request)
- func (b *Builder) SitePrefix(v string) (r *Builder)
- type DocBuilder
- type DocLinkBuilder
- type DocsGroup
Constants ¶
This section is empty.
Variables ¶
This section is empty.
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 (*Builder) BuildStaticSite ¶
func (*Builder) MainPageTitle ¶ added in v0.0.11
func (*Builder) SitePrefix ¶
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) GetPageURL ¶ added in v0.0.11
func (b *DocBuilder) GetPageURL() (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) 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 DocsGroup ¶ added in v0.0.11
type DocsGroup struct {
Title string
Docs []*DocBuilder
}
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.