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.2.0.tar.gz (5.6 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: markdown-up-1.2.0.tar.gz
  • Upload date:
  • Size: 5.6 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.2.0.tar.gz
Algorithm Hash digest
SHA256 6b0da44663feca7cd26c05ce3d2d8f6944ff164ece54837acfa156114934b960
MD5 c17743ea7df96fdd7617d2370f1413d7
BLAKE2b-256 38186d7881a0cbe4ebe6e34852d2e139f5d92ade6e998f19314fb670a4c68a8b

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