Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Markdown editor for web browsers, built with Flask.

Project description

Docs

Build Status Code Coverage Documentation Status PyPi Version Supported Python Versions

Overview

The Browser Markdown Editor is a supremely simple Markdown editor that displays edits in real time. It is a very simple project built with Flask, and the Markdown functionality is implemented with Flask-PageDown. Apart from simply editing Markdown, you may also upload .md files for editing, as well as download the file that is currently being edited.

Requirements

Apart from the requirements listed in requirements.txt, you will also need a web browser of your choice and Python 3.6 or higher.

Install

Option 1: Install from PyPi with pip

The latest release of browser-markdown-editor is on PyPi, and can thus be installed as usual with pip. I strongly discourage system-wide pip installs (i.e. sudo pip install <package>), as this may land you with incompatible packages in a very short amount of time. A per-user install can be done like this:

  1. Execute pip install --user browser-markdown-editor to install the package.
  2. Verify the installation by typing browser-markdown-editor on the command line. It should give you some usage options.
  3. If step 2 fails, it is probably because $HOME/.local/bin is not on your PATH variable. Add it for the current session by executing export PATH="$PATH:$HOME/.local/bin". Add that line to your .bashrc (or equivalent) for this to happen automagically when starting a shell.

Option 2: Clone the repo and the install with pip

If you want the dev version, you will need to clone the repo, as only release versions are uploaded to PyPi. Unless you are planning to work on this yourself, I suggest going with the release version.

  1. Clone the repo with git:
    • git clone https://github.com/slarse/browser-markdown-editor
  2. cd into the project root directory and install with pip.
    • pip install --user ., this will create a local install for the current user.
    • Or just pip install . if you use virtualenv.
    • For development, use pip install -e . in a virtualenv.
  3. Verify the installation by typing browser-markdown-editor on the command line. It should give you some usage options.
  4. If step 3 fails, it is probably because $HOME/.local/bin is not on your PATH variable. Add it for the current session by executing export PATH="$PATH:$HOME/.local/bin". Add that line to your .bashrc (or equivalent) for this to happen automagically when starting a shell.

How to run

To start the server, follow the install instructions and then execute browser-markdown-editor runserver. The host ip will default to 127.0.0.1 and port to 5000. These can be specified by providing -h x.x.x.x and -p n options, where x.x.x.x is the host ip and n is the port to listen to.

License

This software is licensed under the MIT License. See the license file file for specifics.

Contributing

If you feel like you have something meaningful to contribute, by all means, fork the project and open a pull request.

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
browser-markdown-editor-0.2.0.tar.gz (1.9 MB) 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