markdown-up 1.2.6

Markdown viewer application

markdown-up

markdown-up is a Markdown viewer application. To launch markdown-up, run it from the command line:

$ markdown-up

The markdown-up service starts and then opens the web browser to the current directory index by default. You can also open a specific file or directory:

$ markdown-up README.md

How it works

markdown-up first starts a chisel back-end API server to host the markdown-up JavaScript application and host the Markdown static files (it only hosts statics below the root directory). Once the API service has started, the markdown-up application opens the desired directory (index) or Markdown file for viewing.

To view the markdown-up back-end API documentation, open the Chisel documentation application at "/doc".

Development

This project is developed using Python Build. It was started using python-package-template as follows:

template-specialize python-package-template/template/ markdown-up-py/ \
    -k package markdown-up \
    -k name "Craig A. Hobbs" \
    -k email "[e-mail]" \
    -k github "craigahobbs" \
    -k nodoc 1