md

Documentation

Overview

Package md provides some helper functions for creating marked down for Kythe documentation.

Index

• func Link(content, destination string) string
• func ProcessLinks(content string, links []LinkInfo) string
• type LinkInfo

Functions

func Link

func Link(content, destination string) string

Link creates a markdown link. Content must be html and md escaped prior to calling this function.

func ProcessLinks

func ProcessLinks(content string, links []LinkInfo) string

ProcessLinks adds markdown links to the provided content based on the provided link information. This content can be rendered by the client

Types

type LinkInfo

type LinkInfo struct {
	StartByte   int
	Length      int
	Destination string
}

LinkInfo contains information about the placement and destination of linkable text