Permalink
Switch branches/tags
Find file
Fetching contributors…
Cannot retrieve contributors at this time
97 lines (57 sloc) 2.39 KB

mdserver

Build Status NPM Version NPM Downloads Coverage Status Join the chat at https://gitter.im/zhiyelee/mdserver

Static http server with markdown supported.

mdserver can start a http server which acts like the python -m SimpleHTTPServer but has more options

Snapshot

snapshot

Installation

npm install mdserver -g

Options

-p, --port

Type: Number Default: 3333

The port used by the server. Default to 3333

-r, --root

Type: Path Default: current work dictionary (cwd)

The DocumentRoot for the server.

-s, --silent

Type: Boolean Default: false

Silent mode. When set to true, there will no logs been displayed.

--ftpl

Type: Path | String Default: public/fileTpl.html

There are two types of pages

  • directory page: list the files and directories of the current dictionary
  • file page: content of the current file

ftpl is the template used for the file pages. If not set, the option will use the default file provided by the application

--dtpl

Type: Path | String Default: public/dirTpl.html

Template used for the directory pages. If not set, the option will use the default file provided by the application

-l, --style

Type: Path | String Default: public/screen.css

Stylesheet used for the both the directory and file page. If not set, the option will use the default value provided by the application

--view

Type: String Default: details

Display mode.

  • tiles only display file name
  • details display name, size and mtime

Examples

# use default options
mdserver

# custom port, root, and style
mdserver -p 8788 -r ~/github/mdserver -l ~/github/style/base.css

Visit: http://localhost:8788

License

MIT License