https://github.com/y-yagi/mdv

Markdown Viewer
https://github.com/y-yagi/mdv

markdown-viewer

Last synced: about 1 month ago
JSON representation

Markdown Viewer

• Host: GitHub
• URL: https://github.com/y-yagi/mdv
• Owner: y-yagi
• License: mit
• Created: 2021-03-12T06:57:13.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-24T22:43:31.000Z (8 months ago)
• Last Synced: 2024-06-21T16:55:21.419Z (5 months ago)
• Topics: markdown-viewer
• Language: Go
• Homepage:
• Size: 850 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# mdv

The `mdv` is a simple Markdown Viewer.

## Usage

Run `mdv ` at terminal and access to http://localhost:8888/ .

The content automatically refreshes when the file is updated. You don't need to reload a page.

If you point local files in a markdown file, please specify a directory to `dir` option that local files exist.

```bash

mdv -dir . 

```

### Style

`mdv` uses [github-markdown-css](https://github.com/sindresorhus/github-markdown-css) by default.  If you want to use an original style, please specify a `css` option. `mdv` only use the CSS file if `css` option is specified.

```bash

mdv -css  

```

## Installation

Download files from [GitHub release page](https://github.com/y-yagi/mdv/releases).