gdoc

Documentation

Index

• Variables
• func Handle(name string, opts ...Option) []byte
• func UseInGin(r gin.IRouter)
• type Handler
  • func (h *Handler) GetContent(version string, p string) string
  • func (h *Handler) GetSidebar(version string) string
  • func (h *Handler) GetStorageFilePath(name string) string
  • func (h *Handler) GetVersion(version string) map[string]string
  • func (h *Handler) Handle(name string, opts ...Option) []byte
  • func (h *Handler) ParseSidebar(version string) map[string]map[string]string
• type Option
  • func WithTitle(t string) Option

Variables

var DefaultHandler = &Handler{
	DefaultVersionName: "default",
	DocsDir:            "storage/docs",
	PrefixUri:          "docs",
}

Functions

func Handle

func Handle(name string, opts ...Option) []byte

func UseInGin

func UseInGin(r gin.IRouter)

Types

type Handler

type Handler struct {
	DefaultVersionName string
	DocsDir            string
	PrefixUri          string
	// contains filtered or unexported fields
}

func (*Handler) GetContent

func (h *Handler) GetContent(version string, p string) string

func (*Handler) GetSidebar

func (h *Handler) GetSidebar(version string) string

func (*Handler) GetStorageFilePath

func (h *Handler) GetStorageFilePath(name string) string

func (*Handler) GetVersion

func (h *Handler) GetVersion(version string) map[string]string

func (*Handler) Handle

func (h *Handler) Handle(name string, opts ...Option) []byte

func (*Handler) ParseSidebar

func (h *Handler) ParseSidebar(version string) map[string]map[string]string

type Option

type Option func(h *Handler)

func WithTitle

func WithTitle(t string) Option

WithTitle allows you to set the document title.