docs

package
v1.7.4 Latest Latest
Warning

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

Go to latest
Published: Mar 30, 2026 License: GPL-3.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (

	// FS provides access to the embedded markdown docs rooted at the md directory.
	FS = mustSubFS(rawFS, markdownDir)

	// AsciinemaFS provides access to the embedded asciinema recordings.
	AsciinemaFS = mustSubFS(rawFS, asciinemaDir)
)

Functions

func Read

func Read(name string) (string, error)

Read returns the embedded markdown for a doc name, with or without the .md suffix.

func ReadAsciinema

func ReadAsciinema(name string) ([]byte, error)

ReadAsciinema returns the embedded asciinema recording, with or without the .cast suffix.

Types

type Doc

type Doc struct {
	Name    string `json:"name"`
	Content string `json:"content"`
}

Doc is a single embedded markdown document.

type Docs

type Docs struct {
	Docs []Doc `json:"docs"`
}

Docs mirrors the JSON shape used by the docs site.

func All

func All() (Docs, error)

All returns every embedded markdown document.

Jump to

Keyboard shortcuts

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