An open API service indexing awesome lists of open source software.

https://github.com/goark/ml

Make Link with Markdown Format
https://github.com/goark/ml

command-line-tool go golang golang-package

Last synced: 5 months ago
JSON representation

Make Link with Markdown Format

Awesome Lists containing this project

README

          

# [ml] -- Make Link with Markdown Format

[![check vulns](https://github.com/goark/ml/workflows/vulns/badge.svg)](https://github.com/goark/ml/actions)
[![lint status](https://github.com/goark/ml/workflows/lint/badge.svg)](https://github.com/goark/ml/actions)
[![lint status](https://github.com/goark/ml/workflows/build/badge.svg)](https://github.com/goark/ml/actions)
[![GitHub license](https://img.shields.io/badge/license-Apache%202-blue.svg)](https://raw.githubusercontent.com/goark/ml/master/LICENSE)
[![GitHub release](http://img.shields.io/github/release/goark/ml.svg)](https://github.com/goark/ml/releases/latest)

This package is required Go 1.16 or later.

**Migrated repository to [github.com/goark/ml][ml]**

## Build and Install

```
$ go install github.com/goark/ml@latest
```

## Binaries

See [latest release](https://github.com/goark/ml/releases/latest).

## Usage

```
$ ml -h
Usage:
ml [flags] [URL [URL]...]

Flags:
--debug for debug
-h, --help help for ml
-i, --interactive interactive mode
-l, --log int history log size
-s, --style string link style [markdown|wiki|html|csv|json] (default "markdown")
-a, --user-agent string User-Agent string
-v, --version output version of ml
```

```
$ ml https://git.io/vFR5M
[GitHub - goark/ml: Make Link with Markdown Format](https://github.com/goark/ml)
```

```
$ echo https://git.io/vFR5M | ml
[GitHub - goark/ml: Make Link with Markdown Format](https://github.com/goark/ml)
```

### Support Other Styles

```
$ ml -s html https://git.io/vFR5M
GitHub - goark/ml: Make Link with Markdown Format
```

Support Styles: `markdown`, `wiki`, `html`, `csv`, `json`

### Interactive Mode

```
$ ml -i
Input 'q' or 'quit' to stop
ml> https://git.io/vFR5M
[GitHub - goark/ml: Make Link with Markdown Format](https://github.com/goark/ml)
ml>
```

## With Go Codes

```go
package main

import (
"context"
"fmt"
"io"
"os"

"github.com/goark/ml/makelink"
)

func main() {
lnk, err := makelink.New(context.Background(), "https://git.io/vFR5M", "")
if err != nil {
fmt.Fprintln(os.Stderr, err)
return
}
_, _ = io.Copy(os.Stdout, lnk.Encode(makelink.StyleMarkdown))
// Output:
// [GitHub - goark/ml: Make Link with Markdown Format](https://github.com/goark/ml)
}
```

## Modules Requirement Graph

[![dependency.png](./dependency.png)](./dependency.png)

[ml]: https://github.com/goark/ml "goark/ml: Make Link with Markdown Format"