telescope

package
v1.8.0 Latest Latest
Warning

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

Go to latest
Published: Nov 1, 2026 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

Package telescope provides a built-in plugin that adds a command-palette style quick-navigation modal, opened with Ctrl+/ (Cmd+/ on Mac). It ships a fuzzy page search (Fuse.js) over a build-time index of page metadata, plus pinned and recently visited pages persisted in localStorage.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FieldNames

func FieldNames() []string

FieldNames returns the declared config field names, sorted, for config key validation warnings.

func New

func New(cfg map[string]any, st *i18n.StringTable) *plugin.Plugin

New constructs the telescope plugin from its config map and StringTable. st may be nil; UI labels then degrade to their raw i18n keys and the client falls back to built-in English strings.

func NewWithStrings added in v1.6.0

func NewWithStrings(cfg map[string]any, strs func() *i18n.StringTable) *plugin.Plugin

NewWithStrings is New with the string table read at render time: a builder reused across dev rebuilds loads the strings again on every build, and the plugin, registered once, must render the latest ones.

Types

This section is empty.

Jump to

Keyboard shortcuts

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