schemamd

package
v0.0.0-...-2357243 Latest Latest
Warning

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

Go to latest
Published: Jun 2, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package schemamd renders Markdown documentation from JSON Schemas.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ToBoundsStringNumber

func ToBoundsStringNumber(
	placeholder string,
	minNumber, exclMinNumber,
	maxNumber, exclMaxNumber json.Number,
) string

If no bounds are set, the empty string is returned.

func ToBoundsStringValue

func ToBoundsStringValue[T cmp.Ordered](placeholder string,
	minValue, exclMinValue,
	maxValue, exclMaxValue *T) string

If no bounds are set, the empty string is returned.

Types

type Renderer

type Renderer struct {
	// contains filtered or unexported fields
}

Renderer renders Markdown documentation from a JSON Schema.

func NewRenderer

func NewRenderer() *Renderer

NewRenderer creates a Renderer with the default configuration.

func (*Renderer) RenderMarkdown

func (r *Renderer) RenderMarkdown(schema *jsonschema.Schema) string

RenderMarkdown renders Markdown documentation from a JSON Schema.

Jump to

Keyboard shortcuts

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