config

package
v1.7.1-rc0 Latest Latest
Warning

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

Go to latest
Published: Aug 16, 2022 License: MIT Imports: 9 Imported by: 0

README

Configuration Documentation

  1. docs.toml is the source of truth for config docs. Update/add documentation here.

  2. CONFIG.md is generated from docs.toml by config.GenerateDocs() via docs/main.go. Do not edit this file. Run make config-docs from the root of the repo.

See example.toml and example.md for a minimal example.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateDocs

func GenerateDocs() (string, error)

GenerateDocs returns MarkDown documentation generated from docs.toml.

Types

This section is empty.

Directories

Path Synopsis
Docs prints core node documentation and/or a list of errors.
Docs prints core node documentation and/or a list of errors.

Jump to

Keyboard shortcuts

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