mdview

command module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 11, 2024 License: MIT Imports: 21 Imported by: 0

README

Markdown Site

Display nested folders of .md files as a static website with support for LaTeX equations via mathjax and syntax highlighting in code blocks (online only).

Why do this when I could just view the files in VSCode or another modern text editor? Good question. I like (neo)vim instead and while I have used the markdown viewer I wanted to navigate a little more easily. This isn't a good reason, but hey, it was a fun little project.

Usage

To serve files from a directory:

mdview <flags> DIRECTORY

mdview screenshot

Set the -d flag to use darkmode.

mdview screenshot darkmode

For help:

mdview -h

Installation

go install github.com/kevinnowland/mdview@latest

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL