Niche Portobello Mushroom

    mdserver

    2.2.6 • Public • Published

    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/file_template.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/dir_template.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

    Install

    npm i mdserver

    DownloadsWeekly Downloads

    1

    Version

    2.2.6

    License

    MIT

    Unpacked Size

    21.6 kB

    Total Files

    9

    Last publish

    Collaborators

    • th507
    • zhiyelee