marked-terminal-render v0.1.1

Marked Terminal Render

Render markdown on the CLI, with class!

What is it?

Marked Terminal Render is a TUI application for viewing markdown files directly in your terminal. I created it because I wasn't happy with how alternatives handled links in their applications. While the full markdown specification is not yet supported, it will slowly get there. It's a good solution for quickly viewing your markdown notes, or opening external links from someones README. If your terminal support images, they will render.

Installation

Node.js

npm install -g marked-terminal-render

Usage

TUI

Simply run marked-terminal-render without arguments to start the textual user interface and browse local. MD-TUI will find local markdown files in the current directory and below or, if you’re in a Git repository, MD-TUI will search the repo.

Markdown files can be read with MD-TUI's high-performance pager. Most of the keystrokes you know from less are the same, but you can press ? to list the hotkeys.

CLI

In addition to a TUI, MD-TUI has a CLI for working with Markdown. To format a document use a markdown source as the primary argument:

# Read from file
marked-terminal-render README.md

# Fetch README from GitHub / GitLab
marked-terminal-render github.com/0xjwlabs/marked-terminal-render

# Fetch markdown from HTTP
marked-terminal-render https://host.tld/file.md