Search Apps Documentation Source Content File Folder Download Copy Actions Download State String Boolean Number Struct Map Slice Pointer Function Closure Reference Nil Package Type Interface Unknown

helplink source pure

Package helplink provides utilities for creating help page links compatible with Gnoweb, Gnobro, and other clients th...

Overview

Package helplink provides utilities for creating help page links compatible with Gnoweb, Gnobro, and other clients that support the Gno contracts' flavored Markdown format.

This package simplifies the generation of dynamic, context-sensitive help links, enabling users to navigate relevant documentation seamlessly within the Gno ecosystem.

For a more lightweight alternative, consider using p/moul/txlink.

The primary functions — Func, FuncURL, and Home — are intended for use with the "relative realm". When specifying a custom Realm, you can create links that utilize either the current realm path or a fully qualified path to another realm.

Functions 3

func Func

1func Func(title string, fn string, args ...string) string
source

Func returns a markdown link for the specific function with optional key-value arguments, for the current realm.

func FuncURL

1func FuncURL(fn string, args ...string) string
source

FuncURL returns a URL for the specified function with optional key-value arguments, for the current realm.

func Home

1func Home() string
source

Home returns the URL for the help homepage of the current realm.

Types 1

type Realm

ident
1type Realm string
source

Realm represents a specific realm for generating help links.

Methods on Realm

func Func

method on Realm
1func (r Realm) Func(title string, fn string, args ...string) string
source

Func returns a markdown link for the specified function with optional key-value arguments.

func FuncURL

method on Realm
1func (r Realm) FuncURL(fn string, args ...string) string
source

FuncURL returns a URL for the specified function with optional key-value arguments.

func Home

method on Realm
1func (r Realm) Home() string
source

Home returns the base help URL for the specified realm.

Imports 4

Source Files 3