Versions in this module Expand all Collapse all v0 v0.8.0 Mar 16, 2026 Changes in this version type Export + CheckLinks bool + LinkExclude string + LinkRate float64 + LinkTimeout time.Duration + type Validate struct + Exec bool + File string + Format string + Parser *hype.Parser + Timeout time.Duration + Verbose bool + func (cmd *Validate) Flags(stderr io.Writer) (*flag.FlagSet, error) + func (cmd *Validate) Main(ctx context.Context, pwd string, args []string) error + func (cmd *Validate) SetParser(p *hype.Parser) error v0.7.0 Feb 2, 2026 v0.6.0 Feb 1, 2026 Changes in this version type Blog + Info VersionInfo type Export + CustomCSS string + ListThemes bool + NoCSS bool + Theme string + type Preview struct + CustomCSS string + DebounceDelay time.Duration + ExcludeGlobs stringSlice + Extensions string + File string + IncludeGlobs stringSlice + Info VersionInfo + ListThemes bool + OpenBrowser bool + Parser *hype.Parser + Port int + Theme string + Timeout time.Duration + Verbose bool + WatchDirs stringSlice + func (cmd *Preview) Flags(stderr io.Writer) (*flag.FlagSet, error) + func (cmd *Preview) Main(ctx context.Context, pwd string, args []string) error + func (cmd *Preview) ScopedPlugins() plugins.Plugins + func (cmd *Preview) SetParser(p *hype.Parser) error + func (cmd *Preview) WithPlugins(fn plugins.FeederFn) error + type Version struct + Info VersionInfo + func (cmd *Version) Main(ctx context.Context, pwd string, args []string) error + type VersionInfo struct + Commit string + Date string + Version string + func (v VersionInfo) String() string v0.5.0 Jan 25, 2026 Changes in this version + type Blog struct + Timeout time.Duration + Verbose bool + func (cmd *Blog) Flags(stderr io.Writer) (*flag.FlagSet, error) + func (cmd *Blog) Main(ctx context.Context, pwd string, args []string) error + func (cmd *Blog) WithPlugins(fn plugins.FeederFn) error v0.4.1 Jan 25, 2026 v0.4.0 Jan 25, 2026 v0.3.4 Nov 5, 2025 Changes in this version + const DefaultTimeout + func Getwd() (string, error) + func NewBindingNode(p *hype.Parser, el *hype.Element, whole *binding.Whole) (hype.Node, error) + func NewBindingNodes(whole *binding.Whole) hype.ParseElementFn + func NewParser(cab fs.FS, ctxPath string, pwd string) (*hype.Parser, error) + func WithTimeout(ctx context.Context, timeout time.Duration, f func(context.Context) error) error + func WithinDir(dir string, f func() error) error + type App struct + Parser *hype.Parser + func Garlic(root string) (*App, error) + func New(root string) *App + func (cmd *App) Main(ctx context.Context, pwd string, args []string) error + func (cmd *App) ScopedPlugins() plugins.Plugins + type Binding struct + Whole *binding.Whole + func (b *Binding) String() string + type Commander = cleo.Commander + type Encode struct + File string + ParseOnly bool + Parser *hype.Parser + Timeout time.Duration + func (cmd *Encode) Flags() (*flag.FlagSet, error) + func (cmd *Encode) Main(ctx context.Context, pwd string, args []string) error + func (cmd *Encode) SetParser(p *hype.Parser) error + type Env struct + func (e *Env) Getenv(key string) string + func (e *Env) Setenv(key string, value string) + type Export struct + File string + Format string + OutPath OutPath + Parser *hype.Parser + Timeout time.Duration + Verbose bool + func (cmd *Export) Flags(stderr io.Writer) (*flag.FlagSet, error) + func (cmd *Export) Main(ctx context.Context, pwd string, args []string) error + func (cmd *Export) ScopedPlugins() plugins.Plugins + func (cmd *Export) SetParser(p *hype.Parser) error + func (cmd *Export) WithPlugins(fn plugins.FeederFn) error + type Marked struct + ContextPath string + File string + ParseOnly bool + Parser *hype.Parser + Section int + Timeout time.Duration + Verbose bool + func (cmd *Marked) Flags() (*flag.FlagSet, error) + func (cmd *Marked) Main(ctx context.Context, pwd string, args []string) error + func (cmd *Marked) ScopedPlugins() plugins.Plugins + func (cmd *Marked) SetParser(p *hype.Parser) error + func (cmd *Marked) WithPlugins(fn plugins.FeederFn) error + type OutPath struct + func (o *OutPath) Exists() bool + func (o *OutPath) Set(path string) error + func (o *OutPath) String() string + func (o *OutPath) Value() string + type ParserCommander interface + SetParser func(p *hype.Parser) error + type Part binding.Part + func (p Part) Children() hype.Nodes + func (p Part) String() string + type Slides struct + Parser *hype.Parser + Port int + Server *http.Server + func (a *Slides) Describe() string + func (a *Slides) Getenv(key string) (s string) + func (a *Slides) Main(ctx context.Context, pwd string, args []string) error + func (a *Slides) Print(w io.Writer) error + func (a *Slides) SetIO(oi iox.IO) + type TOC struct + func (cmd *TOC) Main(ctx context.Context, pwd string, args []string) error + type VSCode struct + Host string + Parser *hype.Parser + Timeout time.Duration + func (cmd *VSCode) Flags() (*flag.FlagSet, error) + func (cmd *VSCode) Main(ctx context.Context, pwd string, args []string) error v0.3.3 Jul 12, 2025 v0.3.2 Jul 12, 2025 v0.3.1 Apr 29, 2025 v0.3.0 Sep 10, 2024 v0.2.0 Feb 21, 2024 v0.1.2 Feb 12, 2024 v0.1.1 Feb 9, 2024 v0.1.0 Feb 7, 2024
Go to main page