markdown-up 2.2.0

The MarkdownUp launcher

markdown-up

MarkdownUp is a Markdown viewer.

Install MarkdownUp

Use Python's pip to install MarkdownUp as follows:

pip install markdown-up

View Markdown Files

To start MarkdownUp, open a terminal and run the markdown-up application:

markdown-up

The markdown-up application opens the web browser to the MarkdownUp file browser, which allows you to view Markdown or HTML files and navigate directories. To view a file, click on its link.

You can view a specific file as follows:

markdown-up README.md

Note: MarkdownUp runs entirely offline. It does not use an external service to render Markdown files.

Running MarkdownUp

When you run the markdown-up application, in addition to opening the web browser, it starts a chisel backend API application using waitress.

Automatically Creates HTML for Markdown Files

When you run MarkdownUp and click on a Markdown file link, the link navigates to an HTML file that renders the Markdown file. Every Markdown file hosted by MarkdownUp has a corresponding .html file of the same name. For example, if you run Markdown up in a directory that has the following Markdown files: "README.md" and "CHANGELOG.md". The MarkdownUp service automatically generates "README.html" and "CHANGELOG.html" files.

The generated .html files are HTML stubs for the MarkdownUp Front-End Application. All Markdown parsing and rendering are done on the client to minimize server costs.

Command-Line Arguments

The markdown-up application has the following command-line arguments:

usage: markdown-up [-h] [-p N] [-t N] [-n] [-r] [-q] [path]

positional arguments:
  path        the file or directory to view (default is ".")

options:
  -h, --help  show this help message and exit
  -p N        the application port (default is 8080)
  -t N        the number of web server threads (default is 8)
  -n          don't open a web browser
  -r          release mode (cache statics, remove documentation and index)
  -q          don't display access logging

MarkdownUp Applications

MarkdownUp Applications are front-end applications that run within the MarkdownUp Front-End Application using the BareScript programming language. Markdown files viewed within MarkdownUp may contain markdown-script fenced code blocks containing BareScript that executes when the Markdown renders.

MarkdownUp has libraries for dynamically generating and rendering Markdown text, drawing SVG images, performing data analytics, parsing application arguments, and much more. See the MarkdownUp Library and MarkdownUp Include Library for more information.

Here's an example of a simple MarkdownUp application:

# The First Ten Numbers

Here are the first ten numbers:

```markdown-script
i = 1
while i <= 10:
    markdownPrint('', stringNew(i))
    i = i + 1
endwhile
```

Development

This package is developed using python-build. It was started using python-template as follows:

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