md-fileserver/man/mdstart.txt

Locally view markdown files in a browser

MDSTART(1)                                                                  MDSTART(1)

NAME
       mdstart - Locally view markdown files in a browser

SYNOPSIS
         mdstart [options] [<file.md>]

DESCRIPTION
       Starts a local server to render "markdown" files within your browser:

       • Runs on localhost:4000

       • Supports Markdown Syntax http://daringfireball.net/projects/markdown/syntax
         with GFM https://help.github.com/articles/github-flavored-markdown.

       • Markdown  rendering based on markdown-it https://github.com/markdown-it/mark‐
         down-it.   Enabled  Plugins  for:  Emojis,  Task  lists,   Footnotes,   KaTeX
         https://katex.org/

       • Includes markedpp https://github.com/commenthol/markedpp as preprocessor.

       • Supports syntax highlighting using highlight.js http://highlightjs.org

       • For supported markdown syntax see the Cheatsheet.

       • Automatic  update  in  browser  after  saving  edited file. (Tested on Linux,
         MacOS, Windows)

OPTIONS
       • -h, --help: Display this help and exit.

       • --version: Output version information and exit.

       • -p, --port <number=4000>: Change the default port of the server.  Default  is
         4000.

       • -b, --browser <exe>: Use a different browser executable.

       • -c, --confluence : Generate confluence html. Copy and paste the rendered out‐
         put into a editor window at confluence.  Images need manual upload.

       • -o, --output : Build the given file and output as html.

EXAMPLES
       Start the server:

         mdstart

       Open a document in the default browser:

         mdstart README.md

       Open the configuration page:

         mdstart /config

       Open my home directory:

         mdstart /

       Open the cheatsheet:

         mdstart /cheatsheet

       Start with a different browser on port 2000:

         mdstart -p 2000 -b firefox

INSTALLATION
         npm i -g md-fileserver

COPYRIGHT
       Copyright (c) 2014- commenthol - MIT License

REPORTING BUGS
       md-fileserver repository https://github.com/commenthol/md-fileserver/issues

                                     October 2021                           MDSTART(1)