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

Uploaded Source

File details

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

File metadata

  • Download URL: markdown-up-1.3.2.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for markdown-up-1.3.2.tar.gz
Algorithm Hash digest
SHA256 08aa4092274673ad2591eeb445598aafb8a542ee656ed6578dfc5fc025eb6322
MD5 85ecd1bba571e9e79e85dd96d72a1c03
BLAKE2b-256 ab469b38d372f1627501b428750b4b1184d09dd39e4c674f7726437eab44ff16

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