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. 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

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

Uploaded Source

File details

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

File metadata

  • Download URL: markdown-up-1.4.3.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.9

File hashes

Hashes for markdown-up-1.4.3.tar.gz
Algorithm Hash digest
SHA256 0cac8f9cca0516460377238b429d4530100cd11e392196a4f41a647b9e9ff3d5
MD5 23bd6fc556d311af8d17d815d0d2e367
BLAKE2b-256 87708e47882b2baa664d80643c5d3b698f1a9d1e8141bfd311c8e4da813d500e

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