Skip to main content

Local web app rendering your markdown files live

Project description

MarkOne

Local web app rendering your markdown files automatically while you edit them in your favorite editor.

Overview

MarkOne is a small web app that is supposed to be run locally to render your markdown files automatically after you edited them with your favorite editor, e.g. vim.

MarkOne

Installation

Install the app (preferred in a virtual environment):

$ pip install markone

If you want to build it yourself, you first need to install pipenv that feeds setup.py with the project dependencies:

$ pip install pipenv

Afterwards you can install the app from source code:

$ git clone git@github.com:luxmeter/markone.git
$ python setup.py install

Usage

Markone is a flask app that expect you to specify following environment variables:

  • MARKONE_MD_PATH: Path to the markdown files
  • MARKONE_OUTPUT_PATH: Path in which the rendered HTML files will be generated to

Here is an execution example:

MARKONE_MD_PATH=./example/markdown \
MARKONE_OUTPUT_PATH=./example/html \
MARKONE_PORT=5000 \
FLASK_APP=markone.main \
flask run --port 5000

The app can be than opened under

http://localhost:5000

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
markone-0.0.4-py3-none-any.whl (123.8 kB) Copy SHA256 hash SHA256 Wheel py3
markone-0.0.4.tar.gz (133.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page