Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

A simple markdown server.

Project description

Markdown-server is a simple web application. It converts markdown file to HTML and response by text/html.

How to use

Runtime Environment

Python:2.7.9
pip:6.1.1
virtualenv:12.1.1

Library Dependencies

See requirements.txt.

Just try

Start server

You don’t need any special preparation to try to start server. Just execute below commands.

$ git clone https://github.com/ohbarye/markdown-server
$ cd markdown-server
$ virtualenv .venv
$ source .venv/bin/activate
(.venv)$ pip install -r requirements.txt
(.venv)$ markdownserver
    Bottle v0.12.8 server starting up (using WSGIRefServer())...
    Listening on http://localhost:8009/

Or, you can install from PyPi.

(.venv)$ pip install markdown-server
(.venv)$ markdownserver
    Bottle v0.12.8 server starting up (using WSGIRefServer())...
    Listening on http://localhost:8009/

If server start up successfully, browse below URL and check the converted result.

$ open http://localhost:8009/sample.md

Only Conversion

Additionally, You can use the conversion function alone.

(.venv)$ convert source_md_file target_html_file

Do as you like

  • Markdown server purvey http://host/[file_name] URL. This corresponds to resources/markdown/[file_name].You can put any markdown file here.

  • Converted file will be placed to resources/html directory. Generated html file includes CSS so it’s ease to distribute.

  • Environment variables like host name or port number are set in env.py. Edit arbitrarily.

    ms_port        = '8009'
    ms_host        = 'localhost'
    
  • The default markdown engine is Github flavored Markdown. If you want to use another style, add CSS and edit env.py.

    css_name       = 'github.css'
    markdown_type  = 'gfm'
    

Project details


Release history Release notifications

This version
History Node

0.1.3

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

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
markdown_server-0.1.3-py2-none-any.whl (18.0 kB) Copy SHA256 hash SHA256 Wheel 2.7 Aug 1, 2016
markdown-server-0.1.3.tar.gz (10.9 kB) Copy SHA256 hash SHA256 Source None Aug 1, 2016

Supported by

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