Skip to main content

Markdown Server

Project description

mds - markdown server

Markdown Server is a simple Python application that serves local markdown files in your browser for simple viewing and editing. Markdown server is still in early development.

Installation

Via pip:

pip3 install mds

Via setup.py:

pip3 install mistune bottle

python3 setup.py install

Usage

To use markdown server you simply need to point it to a directory where you keep markdown files. It will recursively search through the directory for files with a *.md extension. These can then be viewed and edited in the browser at localhost:3000.

Serve notes on default port:

mds ~/notes

Serve notes on specific ports:

mds -p 8080 ~/notes

Contributing

Contributing is welcome, just make a PR.

License

MIT

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

mds-0.0.6.tar.gz (15.0 kB view hashes)

Uploaded Source

Built Distributions

mds-0.0.6-py3-none-any.whl (21.8 kB view hashes)

Uploaded Python 3

mds-0.0.6-py2.py3-none-any.whl (21.8 kB view hashes)

Uploaded Python 2 Python 3

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