Popularity
2.7
Declining
Activity
0.0
Stable
42
2
2

Description

Allows to view markdown files in the default browser. For more details, see the API documentation.

Programming language: Go
License: MIT License
Tags: Markdown     README     Github    
Latest version: v1.1.2

README

GoDoc Build Status Go Report Card

mdopen

Allows to view markdown files in the default browser. For more details, see the API documentation.

CLI usage

Install:

go get github.com/romanyx/mdopen/cmd/mdopen

Create a markdown file:

echo "# Hello from markdown" > hello.md

View it in the default browser as html:

mdopen hello.md

You will see:

Example

API usage

Install:

go get github.com/romanyx/mdopen
package main

import "github.com/romanyx/mdopen"

func main() {
    f := strings.NewReader("# Hello from markdown")

    opnr := mdopen.New()
    if err := opnr.Open(f); err != nil {
        log.Fatal(err)
    }
}

Contributing

Please feel free to submit issues, fork the repository and send pull requests!