generators

package
v0.0.0-...-881f1dc Latest Latest
Warning

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

Go to latest
Published: Apr 18, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CleanupForInclude

func CleanupForInclude(md string) string

CleanupForInclude parts of markdown that will make difficult to use it as include in the website: - The title of the document (this allow more flexibility for include, e.g. include in tabs) - The sections see also, that assumes file will be used as a main page

func GenMarkdownTree

func GenMarkdownTree(cmd *cobra.Command, dir string, withTitle bool) error

func GenMarkdownTreeCustom

func GenMarkdownTreeCustom(cmd *cobra.Command, dir string, subdir string, filePrepender, linkHandler func(string) string, withTitle bool) error

func GenReference

func GenReference(cmd *cobra.Command, w io.Writer, linkHandler func(string) string, withTitle bool, indexFile bool) error

func MarkdownPostProcessing

func MarkdownPostProcessing(cmd *cobra.Command, dir string, processor func(string) string) error

MarkdownPostProcessing goes though the generated files

Types

This section is empty.

Jump to

Keyboard shortcuts

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