format

package

v0.0.9 Latest Latest Go to latest Published: May 3, 2026 License: GPL-3.0 Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/dancsecs/gotomd

Links

Open Source Insights

Documentation ¶

Overview ¶

Package format defines methods to markdown template content into either .go or .md formats.

Index ¶

func BalancedComment(line string) string
func Comment(line string) string
func ForGoDoc()
func ForMarkdown()
func HLine() string
func Inline(language, body string) string
func IsForMarkdown() bool
func Usage(lines string) string

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BalancedComment ¶

func BalancedComment(line string) string

BalancedComment returns the string centered in a comment line.

func Comment ¶

func Comment(line string) string

Comment creates a stand alone comment.

func ForGoDoc ¶

func ForGoDoc()

ForGoDoc code for markdown templates.

func ForMarkdown ¶

func ForMarkdown()

ForMarkdown sets the format style.

func HLine ¶

func HLine() string

HLine returns a horizontal line.

func Inline ¶

func Inline(language, body string) string

Inline frames the content in a ```language ... ``` multiline block for an .md output and prefixes each body line with a tab "\t" character for a go package document.

func IsForMarkdown ¶

func IsForMarkdown() bool

IsForMarkdown returns true if current formatting targets am .md file.

func Usage ¶ added in v0.0.9

func Usage(lines string) string

Usage returns a formatted string representing a command's usage information.

Types ¶

This section is empty.

Source Files ¶

View all Source files

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