This is a Python Virtual environment for running a live markdown previewer.
It has grip (https://github.com/joeyespo/grip) installed which runs a web
server, monitoring a markdown file being edited in a external editor, and
updates live as the file changes, auto converting from markdown to HTML.
To set up:
- Create the
markdownViewerdirectory and change to it - Set up the virtual environment:
$ virtualenv venv
- NOTE: on Debian Jessie system with no other python than python3 installed,
you will have to add the `--python=python3` option to virtualenv.
- Source the
activateenvironment from the thevenv/bindir:
$ source venv/bin/activate
- Install grip:
$ pip install grip
To start:
- Source the
activateenvironment from the thevenv/bindir:
$ source venv/bin/activate
- With the virtual environement active, try
grip --help - To view a markdown file in any directory, change to that directory then run:
$ grip -v anyfile.md
Check the github page or grip --help for more.
Alternative start:
- Symlink the
markdownViewer.shto somewhere in your PATH - I have a~/bin/dir in my home which is in my PATH, so I symlink it to there. This must be a symlink, and not a copy of the script! - Run
markdownViewer.shfrom within any directory you you need, and pass anygriparguments directly tomarkdownViewer.shNOTE: This assumes the virtual environment is in a directory calledvenv