makelink

package

v0.6.8 Latest Latest Go to latest Published: Oct 14, 2023 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/goark/ml

Links

Open Source Insights

Documentation ¶

Index ¶

func StyleList() string
type Link
- func New(ctx context.Context, urlStr, userAgent string) (*Link, error)
type Style
- func GetStyle(s string) (Style, error)
- func (t Style) String() string

Examples ¶

New

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func StyleList ¶

func StyleList() string

StyleList returns string Style list

Types ¶

type Link ¶

type Link struct {
	URL         string `json:"url,omitempty"`
	Location    string `json:"location,omitempty"`
	Canonical   string `json:"canonical,omitempty"`
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
}

Link class is information of URL

func New ¶

func New(ctx context.Context, urlStr, userAgent string) (*Link, error)

New returns new Link instance

Example ¶

link, err := New(context.Background(), "https://git.io/vFR5M", "")
if err != nil {
	fmt.Println(err)
	return
}
fmt.Println(link.Encode(StyleMarkdown))

Output:

[GitHub - goark/ml: Make Link with Markdown Format](https://github.com/goark/ml)

func (*Link) CanonicalURL ¶

func (lnk *Link) CanonicalURL() string

CanonicalURL returns the canonical URL.

func (*Link) Encode ¶

func (lnk *Link) Encode(t Style) io.Reader

Encode returns string (io.Reader) with other style

func (*Link) String ¶

func (lnk *Link) String() string

func (*Link) TitleName ¶

func (lnk *Link) TitleName() string

TitleName returns string of title name

type Style ¶

type Style int

Style as link style

const (
	//StyleUnknown is unknown link style
	StyleUnknown Style = iota
	//StyleMarkdown is unknown markdown style
	StyleMarkdown
	//StyleWiki is unknown wiki style
	StyleWiki
	//StyleHTML is unknown HTML anchor style
	StyleHTML
	//StyleCSV is CSV data format
	StyleCSV
	//StyleJSON is JSON format
	StyleJSON
)

func GetStyle ¶

func GetStyle(s string) (Style, error)

GetStyle returns Style from string

func (Style) String ¶

func (t Style) String() string

Source Files ¶

View all Source files

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