mdxgen

Documentation

Index

• func RenderIndexMDX(ctx context.Context, pd PackageData) (string, error)
• type Options
• type PackageData
• type Summary
  • func Generate(ctx context.Context, srcDir, outDir string) (Summary, error)
  • func GenerateWithOptions(ctx context.Context, srcDir, outDir string, opts Options) (Summary, error)

Functions

func RenderIndexMDX

func RenderIndexMDX(ctx context.Context, pd PackageData) (string, error)

RenderIndexMDX renders a single package page.

Types

type Options

type Options struct {
	// IgnoreFile is an optional path to an extra ignore file, relative to srcDir
	// unless absolute. It is applied after .gitignore/.mdxignore.
	// Missing files are ignored silently.
	IgnoreFile string
}

Options controls generation behavior.

type PackageData

type PackageData struct {
	Path        string
	Name        string
	ModulePath  string
	Version     string
	Synopsis    string
	Description string
	Readme      string
	DocSource   []byte
}

PackageData contains the minimum data needed to render a package page.

type Summary

type Summary struct {
	Generated int
	Skipped   int
	Failed    int
}

Summary reports generator results.

func Generate

func Generate(ctx context.Context, srcDir, outDir string) (Summary, error)

Generate creates MDX content for local packages under srcDir into outDir.

func GenerateWithOptions

func GenerateWithOptions(ctx context.Context, srcDir, outDir string, opts Options) (Summary, error)

GenerateWithOptions creates MDX content with custom options.