Skip to content

big-wheel/mdtv

Repository files navigation

mdtv

NPM version NPM Downloads

mdtv is a command-line http server to show markdown file

You also can use mdtv for:

  • preview directory/file
  • download file

Installing globally:

npm install mdtv -g

This will install mdtv globally so that it may be run from the command line.

Usage:

mdtv [options]

Now you can visit http://localhost:8089 to view you server.

If there is index.md/index.html in the current directory, mdtv will give priority to show them or show the directory

Available Options

-V, --version          output the version number
-m, --mdName <mdName>  specify the name of md file to show
-p, --port <port>      set the port to use
-t, --toc              whether to show table of content of md files
-h, --help             output usage information