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.
Automatic 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 MarkdownUp 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 frontend application.
All Markdown parsing and rendering are done on the client.
Configuration File
The
MarkdownUp Application Configuration File,
markdown-up.json, allows you to enable release mode, set the number of backend server threads, and more.
Command-Line Arguments
The markdown-up application has the following command-line arguments:
usage: markdown-up [-h] [-p N] [-t N] [-n] [-r] [-q] [-c FILE] [path]
positional arguments:
path the file or directory to view (default is ".")
options:
-h, --help show this help message and exit
-p, --port N the application port (default is 8080)
-t, --threads N the number of web server threads (default is 8)
-n, --no-browser don't open a web browser
-r, --release release mode (cache statics, remove documentation and index)
-q, --quiet hide access logging
-c, --config FILE the application config filename (default is "markdown-up.json")
MarkdownUp Applications
With MarkdownUp, you can write client-rendered frontend applications using
BareScript.
MarkdownUp applications are created by adding markdown-script fenced code blocks containing
BareScript
to a Markdown file and viewing it with the MarkdownUp frontend application. When the Markdown file
is rendered, the BareScript is executed and its results are rendered in place. For example:
# Frontend Hello World
```markdown-script
markdownPrint('Hello, **World**!!')
```
MarkdownUp Application Reference
MarkdownUp Backend Applications
MarkdownUp no longer hosts BareScript backend APIs. To write a backend application in BareScript, use the bare-script package's WSGI support.
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 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapi 1
Metadata
Release files for markdown-up 3.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| markdown_up-3.3.0.tar.gz | 10.7 kB | Without provenance | Details for markdown_up-3.3.0.tar.gz |
Release files / markdown_up-3.3.0.tar.gz
| Download URL | markdown_up-3.3.0.tar.gz |
|---|---|
| Size | 10.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
34b59d62235eb3f0a3762390ea3f6a9f2b9e10d1404ef198429b90763478cad7
|
|
BLAKE2b-256 checksum How to use checksums |
1d0b56bb914c55cc519f1eb0e8d353a29acc984b5b80cb00202e28e27804f697
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Security for markdown-up 3.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.