https://github.com/thiamsantos/mdpreview

Preview markdown files
https://github.com/thiamsantos/mdpreview

command-line markdown preview

Last synced: 4 days ago
JSON representation

Preview markdown files

• Host: GitHub
• URL: https://github.com/thiamsantos/mdpreview
• Owner: thiamsantos
• License: apache-2.0
• Created: 2021-01-25T16:43:23.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-02-05T21:31:34.000Z (almost 3 years ago)
• Last Synced: 2024-10-12T16:32:03.434Z (about 1 month ago)
• Topics: command-line, markdown, preview
• Language: Go
• Homepage:
• Size: 25.4 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mdpreview

> Preview markdown files.

Markdown files are rendered using [Github API](https://docs.github.com/en/rest/reference/markdown#render-a-markdown-document-in-raw-mode).

GitHub Markdown style are provided by [github-markdown-css](https://github.com/sindresorhus/github-markdown-css).

## Installation

You need `go` installed and `GOBIN` in your `PATH`. Once that is done, run the

command:

```shell

$ go get -u github.com/thiamsantos/mdpreview

```

## Usage

```

Usage

  $ mdpreview [options]

Options

  -i string

        Markdown file to render (default "README.md")

Examples

  $ mdpreview

  $ mdpreview -f some/file.md

```