editor

Documentation

Index

• Constants
• func Serialize(notebook *Notebook) ([]byte, error)
• type Cell
• type CellKind
• type Notebook
  • func Deserialize(data []byte) (*Notebook, error)
• type TextRange

Constants

const FrontmatterKey = "runme.dev/frontmatter"

Functions

func Serialize

func Serialize(notebook *Notebook) ([]byte, error)

Types

type Cell

type Cell struct {
	Kind       CellKind          `json:"kind"`
	Value      string            `json:"value"`
	LanguageID string            `json:"languageId"`
	Metadata   map[string]string `json:"metadata,omitempty"`
	TextRange  *TextRange        `json:"textRange,omitempty"`
}

Cell resembles NotebookCellData from VS Code. https://github.com/microsoft/vscode/blob/085c409898bbc89c83409f6a394e73130b932add/src/vscode-dts/vscode.d.ts#L13715

type CellKind

type CellKind int

const (
	MarkupKind CellKind = iota + 1
	CodeKind
)

type Notebook

type Notebook struct {
	Cells    []*Cell           `json:"cells"`
	Metadata map[string]string `json:"metadata,omitempty"`
}

Notebook resembles NotebookData form VS Code. https://github.com/microsoft/vscode/blob/085c409898bbc89c83409f6a394e73130b932add/src/vscode-dts/vscode.d.ts#L13767

func Deserialize

func Deserialize(data []byte) (*Notebook, error)

type TextRange

type TextRange struct {
	Start int `json:"start"`
	End   int `json:"end"`
}