godoc

package
v1.5.54 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 20, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package godoc is an mdbook preprocessor to inline `go doc` output.

Any preprocessor directive like

{{# godoc <arg>... }}

Will have the equivalent of `go doc arg...` run and inserted as code blocks.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Register

func Register(ctx context.Context, cfg *mdbook.Context, p *mdbook.Proc) error

Register registers the preprocessor.

Types

This section is empty.

Notes

Bugs

  • This package should use the `go/doc/comment` package to generate HTML or Markdown.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL