Skip to main content

Markdown viewer application

Project description

markdown-up

PyPI - Status PyPI GitHub PyPI - Python Version

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdown-up-1.1.0.tar.gz (6.1 kB view details)

Uploaded Source

File details

Details for the file markdown-up-1.1.0.tar.gz.

File metadata

  • Download URL: markdown-up-1.1.0.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.2

File hashes

Hashes for markdown-up-1.1.0.tar.gz
Algorithm Hash digest
SHA256 e3562621409e34a6dcfc66518fdb8c4b7f3dab18b8dd5bcb8ac792e6743da09b
MD5 253a63edad20b769520a2c9ca15f1d24
BLAKE2b-256 49875e4a0d29bd5b0cd8e641f38bb4c0cc42a8d65a04c0c006dda724edee7b38

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page